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.
npm install
npm run search-meta:gen
npm run devSee also contributing/docs#building-the-website.
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:devFor production deployment:
docker build -t ghcr.io/unikraft/docs:runner --target runner .
docker run -it --rm -p 3000:3000 ghcr.io/unikraft/docs:runnerPlease see our Contribution Guide for more details.