- Install
Python 2.7
- the static site generator MkDocs
pip install -U mkdocs
- fenced code block highlighting
pip install -U pygments
- Nice markdown extensions for python
pip install -U pymdown-extensions
- Material design theme for MkDocs
- System-wide install
pip install -U mkdocs-material
- Or just clone the theme repo from GitHub
git clone https://github.com/squidfunk/mkdocs-material.git
. The theme will reside in the foldermkdocs-material/material
. Copy it and point yourmkdocs.yml
to it like this:
theme: name: 'material' custom_dir: 'themes/material' language: 'en' palette: primary: 'indigo' accent: 'indigo'
- Also in
mkdocs.yml
you might want to add the following config:
This helps with serving the website using GitHub pages, when it's configured to serve contents ofdocs_dir: 'src' site_dir: 'docs'
master/docs
- System-wide install
Just copy the example site from the Material theme.
Execute from the site
sub-folder:
mkdocs build --clean
And push to GitHub. The repo is configured to serve the site from master/docs
.