Skip to content

Eva-my-Name/nerva-docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 

Repository files navigation

nerva-docs

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

Copyright (c) 2021 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'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. The generated HTML is located in the gh-pages branch.

Building the docs locally

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/mrsyzygy/mkdocs-bootstrap4.git
$ MKDOCS_GIT_COMMITTERS_APIKEY=<Your-Access-Token-Here> mkdocs build

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

About

Official NERVA (XNV) documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors