shai-almog/documentation

Live coding documentation

Setup

Requirements

• MkDocs
• pip

sudo apt update
sudo apt install python3-pip
sudo apt-get install mkdocs
pip3 install mkdocs-material
pip3 install mkdocs-awesome-pages-plugin
pip3 install fancyboxmd
pip3 install mkdocs-macros-plugin
pip3 install mkdocs-git-revision-date-localized-plugin

Usage

Serve Docs

mkdocs serve

Visit: http://127.0.0.1:8000/