MkDocs

Getting Started

# Install
pip install mkdocs

# Create a new doc app.
mkdocs new notes

# Serve (will serve on port 8000).
mkdocs serve

Deployment

Assuming GitHub Pages is configured to serve from gh-pages branch at /(root), running the following command would automatically generate the static files and push them to that branch:

mkdocs gh-deploy

Alternatively, the command below can generate the files in a local site directory:

mkdocs build

Resources