MkDocs
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 …
Getting Started - MkDocs
By default, MkDocs uses the MkDocs favicon icon. To use a different icon, create an img subdirectory in the docs directory and copy your custom favicon.ico file to that directory.
Installation - MkDocs
MkDocs requires a recent version of Python and the Python package manager, pip, to be installed on your system. You can check if you already have these installed from the command line:
Writing Your Docs - MkDocs
MkDocs allows you to interlink your documentation by using regular Markdown links. However, there are a few additional benefits to formatting those links specifically for MkDocs as outlined …
User Guide - MkDocs
The MkDocs User Guide provides documentation for users of MkDocs. See Getting Started for an introductory tutorial. You can jump directly to a page listed below, or use the next and previous …
Configuration - MkDocs
MkDocs uses the Python Markdown library to translate Markdown files into HTML. Python Markdown supports a variety of extensions that customize how pages are formatted.
Deploying Your Docs - MkDocs
Behind the scenes, MkDocs will build your docs and use the ghp-import tool to commit them to the gh-pages branch and push the gh-pages branch to GitHub. Use mkdocs gh-deploy --help to …
Choosing Your Theme - MkDocs
Installing an MkDocs theme means installing a Python package and executing any code that the author has put in there. So, exercise the usual caution; there's no attempt at sandboxing.
Command Line Interface - MkDocs
Usage: mkdocs [OPTIONS] COMMAND [ARGS]... Options: ... Subcommands build: Build the MkDocs documentation get-deps: Show required PyPI packages inferred from plugins in …
Themes - MkDocs
To see an example of a package containing one theme, see the MkDocs Bootstrap theme and to see a package that contains many themes, see the MkDocs Bootswatch theme.