johannsdg.github.io

These documentation pages for Johann S. D. G. were created with MkDocs. As such, they can be cloned and taken with you in situations where you may not have internet access. Note: This requires python and the mkdocs python library to function.

Online Documentation

To deploy updates to github pages:

• Run the following command in the root repo folder

mkdocs gh-deploy

Offline Documentation

To host the documentation locally:

• Clone the johannsdg repo and move to that directory

git clone https://github.com/johannsdg/johannsdg.github.io.git
cd johannsdg.github.io/

• Use pip to install mkdocs

pip install mkdocs

• Use mkdocs to build the web pages

mkdocs build

• And finally, use mkdocs again to host the site

mkdocs serve

By default the webpage will be served at http://127.0.0.1:8000/ for more information please see the mkdocs getting started guide.