MkDocs

What MkDocs is

MkDocs is a free static site generator for project documentation written in Markdown and configured with a YAML file. It turns documentation into static HTML that can be hosted on GitHub Pages, Amazon S3, or another static-file service. A local development server previews the site and reloads it after changes, while generated documentation includes search that can link directly to matching sections. The built-in mkdocs and readthedocs themes are available alongside third-party and custom themes. Themes, plugins, Markdown extensions, and configuration settings provide ways to shape the output. MkDocs uses Python-Markdown and requires a recent Python version and pip. Its command-line tools include commands for creating projects, serving previews, building sites, getting dependencies, and deploying to GitHub Pages. The built-in mkdocs theme supports multiple locales, including English, German, Spanish, French, Japanese, and Chinese. MkDocs is distributed under the BSD license. Keep in mind that third-party themes and plugins execute code from their authors, and MkDocs does not sandbox that code.