MkDocs is static page generator written in Python with focus on documentation. The source files are in Markdown format. It has very good support of plugins and extensions (thanks to python-markdown). It is easy to start with and building the site is straightforward. It has build-in web server to serve the site and automatically detect changes and autoreloads the page. There are build-in themes and plenty of good third party themes.
- Python installed.
- Python virtual environment created. Use virtualenvwrapper to manage virtual environments. See virtual environment tutorial for more details.
- make tool for convenience (optional, very likely your linux already has it installed)
- Examples were tested on Ubuntu Linux
- 01-minimal-example contains minimal configuration needed to build static site with MkDocs
- 02-advanced-example contains more advanced examples with multiple plugins, extensions enabled.
Feel free to ask question via Issues. PR are welcomed. Please leave a feedback.