https://github.com/unikraft/docs
The front page and documentation for the Unikraft Open-Source Project.
https://github.com/unikraft/docs
blog documentation events hackathons hacktoberfest hacktoberfest2022 hugo website
Last synced: 10 months ago
JSON representation
The front page and documentation for the Unikraft Open-Source Project.
- Host: GitHub
- URL: https://github.com/unikraft/docs
- Owner: unikraft
- License: other
- Created: 2022-01-10T07:01:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-29T11:02:41.000Z (about 1 year ago)
- Last Synced: 2025-03-28T22:12:15.116Z (11 months ago)
- Topics: blog, documentation, events, hackathons, hacktoberfest, hacktoberfest2022, hugo, website
- Language: MDX
- Homepage: https://unikraft.org
- Size: 90.8 MB
- Stars: 35
- Watchers: 8
- Forks: 95
- Open Issues: 71
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Unikraft Documentation
This is the repository hosting Unikraft documentation.
It is deployed on the [Unikraft website](https://unikraft.org/)
It provides information for the latest version of [Unikraft](https://github.com/unikraft/unikraft) and [KraftKit](https://kraftkit.sh).
Documentation is written in [MDX](https://mdxjs.com/) format.
Building and deploying it requires Node and NPM.
You can build and run either natively or using Docker.
## Building and Testing Natively
```console
npm install
npm run search-meta:gen
npm run dev
```
See also [contributing/docs#building-the-website](https://unikraft.org/docs/contributing/docs#building-the-website).
## Using Docker
In order to use Docker, follow [the instructions](https://docs.docker.com/get-started/).
For local development:
```console
docker build -t ghcr.io/unikraft/docs:dev --target dev .
docker run -it --rm -v $(pwd):/docs -w /docs -p 3000:3000 ghcr.io/unikraft/docs:dev
```
For production deployment:
```console
docker build -t ghcr.io/unikraft/docs:runner --target runner .
docker run -it --rm -p 3000:3000 ghcr.io/unikraft/docs:runner
```
## Contributing
Please see our [Contribution Guide](https://unikraft.org/docs/contributing/docs) for more details.