How to update documentation

Running MkDocs Framework

MkDocs has been set up on our repository (/docs).

First, install MkDocs and other required packages by

pip install mkdocs
pip install mkdocs-material
pip install pymdown-extensions

To launch the website on your local machine, issue the following command on a command line interface:

mkdocs serve

To release your documentation to the public website (http://verdictdb.org/verdictdb-dev/ for now), type

mkdocs gh-pages

Then, your changes are pushed to the gh-pages branch, which serves the above website.