Overview

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

This repository is used as a template to quickly create a new project.

For more details please refer to http://www.mkdocs.org/

Tools

  • build.bat : Build the MkDocs documentation
  • deploy.bat : Deploy the documentation to GitHub Pages
  • dev.bat : Run the builtin development server

Third Party Themes

A list of third party themes can be found in the MkDocs community wiki.

Install

pip install mkdocs pymdown-extensions