Official NERVA documentation (https://docs.nerva.one)

Copyright (c) 2018 - 2023 NERVA Project

All you need to help us write the docs is a basic knowledge of the Markdown formatting language, which is easy to learn. To contribute you'll need to fork this repository, make your desired changes and then submit a pull request to merge those changes. If you're unfamiliar with this process, feel free to ask for help on Discord.

Contributions may not immediately appear on the website, as the docs must first be built (into HTML) via mkdocs.

Requires python/pip and git. You'll also need to generate a GitHub personal access token with full read permissions.

$ pip install mkdocs mkdocs-git-committers-plugin
$ git clone https://github.com/nerva-project/nerva-docs.git
$ cd nerva-docs
$ git clone https://github.com/nerva-project/nerva-docs-theme.git
$ MKDOCS_GIT_COMMITTERS_APIKEY=<Your-Access-Token-Here> mkdocs build

The generated HTML files will be placed in the site subdirectory.