Show Help¶
Run mkdocs -h
to make sure mkdocs is installed and to see the CLI help. It should look like...
Usage: mkdocs [OPTIONS] COMMAND [ARGS]...
MkDocs - Project documentation with Markdown.
Options:
-V, --version Show the version and exit.
-q, --quiet Silence warnings
-v, --verbose Enable verbose output
--color / --no-color Force enable or disable color and wrapping for the output. Default is
auto-detect.
-h, --help Show this message and exit.
Commands:
build Build the MkDocs documentation
get-deps Show required PyPI packages inferred from plugins in mkdocs.yml
gh-deploy Deploy your documentation to GitHub Pages
new Create a new MkDocs project
serve Run the builtin development server