Dev Blog


Original theme by orderedlist (CC-BY-SA)

Where applicable, all content is licensed under a CC-BY-SA.
Creative Commons License

MkDocs Static Site - Quickstart

sudo pip install mkdocs
mkdocs new $site
cd $site

Assume the following all work under $site.

Create the directory structure:

mkdir dev_theme dev_theme/css dev_theme/js
wget -O dev_theme/css/pygment_trac.css
wget -O dev_theme/css/styles.css
wget -O dev_theme/js/scale.fix.js

mkdocs.yml using the minimal theme:

site_name: dev
  - ""
  - ""
  - ""
  - ""
  - ""
  - ""
  - ""
  - ""
  - ""

docs_dir: 'wiki'
theme_dir: 'dev_theme'
  base : "/dev/"

MkDocs uses jinja2 for templates.

To test (note, you need to change config.extra.base for this setup):

mkdocs serve

To build the static site in the site subdir:

mkdocs build