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: about 7 hours 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 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-13T13:10:14.000Z (6 days ago)
• Last Synced: 2025-01-13T14:23:49.414Z (6 days ago)
• Topics: blog, documentation, events, hackathons, hacktoberfest, hacktoberfest2022, hugo, website
• Language: MDX
• Homepage: https://unikraft.org
• Size: 90.7 MB
• Stars: 35
• Watchers: 9
• Forks: 87
• Open Issues: 65
• 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.