problame/docs

The front page and documentation for the Unikraft Open-Source Project.

Unikraft Documentation

This is the repository hosting Unikraft documentation. It is deployed on the Unikraft website It provides information for the latest version of Unikraft and KraftKit.

Documentation is written in MDX format. Building and deploying it requires Node and NPM. You can build and run either natively or using Docker.

Building and Testing Natively

npm install

npm run search-meta:gen

npm run dev

See also contributing/docs#building-the-website.

Using Docker

In order to use Docker, follow the instructions.

For local development:

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:

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 for more details.