mkdocs (1) Linux Manual Page
mkdocs – Create HTML documentation from markdown sources
Synopsis
mkdocs [build|gh-deploy|new|serve] {options}Description
MkDocs is a fast and simple way to create a website from source files written in Markdown, and configured with a YAML configuration file, the documentation can be hosted anywhere, even in free hosting services like Read the Docs and GitHub Pages.Options
- –help
- display help and exit
- new
- <name> create a new project with under the <name> directory
- build
- make a HTML website from sources
- serve
- start a server to view in real time the documentation
- gh-deploy
- commit changes to a GitHub Page