Offline Documentation

MkDocs

These documentation pages for Johann 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.

To host the documentation locally:

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.