Skip to content
Official NERVA (XNV) documentation
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
LICENSE
README.md
mkdocs.yml

README.md

nerva-docs

Official NERVA documentation (https://docs.getnerva.org)

Copyright (c) 2019 The NERVA Project

Contributing

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 aren't familiar with this process, feel free to ask for help on Discord: https://discord.gg/xBHxnGN

Contributions may not immediately appear on the website, as the docs must first be rebuilt (into HTML) via mkdocs. The generated HTML is located in the gh-pages branch.

Building the docs locally

Set environment variable MKDOCS_GIT_COMMITTERS_APIKEY to your GitHub personal access token.

$ 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/mrsyzygy/mkdocs-bootstrap4.git
$ mkdocs build
You can’t perform that action at this time.