mkdocs

to get started with mkdocs.

Structure Files

project
│   README.md
└───src
│   │   docs
│   │   site
│   │   mkdocs.yml
└───template
    │   docs
    │   material
    │   mkdocs.yml

• src - mkdocs minimum

• docs - mkdocs source code

• site - mkdocs build directory

• mkdocs.yml - mkdocs config

• templates - mkdocs-material template

Install

• pip install mkdocs
• pip install mkdocs-material
• pip install mkdocs-redirects
• pip install mkdocs-minify-plugin

Development

• mkdocs serve

Serving on http://127.0.0.1:8000

Building the site

• mkdocs build

Creating a new project

• mkdocs new my-project

• cd my-project

Sources:

• mkdocs

• GitHub Pages

• markdownguide.org