Click

This demo site shows the rendering of the MkDocs CLI itself through mkdocs-click.

cli

MkDocs - Project documentation with Markdown.

Usage:

cli [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`-V`, `--version`	boolean	Show the version and exit.	`False`
`-q`, `--quiet`	boolean	Silence warnings	`False`
`-v`, `--verbose`	boolean	Enable verbose output	`False`
`--color` / `--no-color`	boolean	Force enable or disable color and wrapping for the output. Default is auto-detect.	None
`--help`	boolean	Show this message and exit.	`False`

build

Build the MkDocs documentation.

Usage:

cli build [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--clean` / `--dirty`	boolean	Remove old files from the site_dir before building (the default).	`True`
`-f`, `--config-file`	filename	Provide a specific MkDocs config. This can be a file name, or '-' to read from stdin.	None
`-s`, `--strict` / `--no-strict`	boolean	Enable strict mode. This will cause MkDocs to abort the build on any warnings.	None
`-t`, `--theme`	choice (`ledger` \| `material` \| `mkdocs` \| `readthedocs`)	The theme to use when building your documentation.	None
`--use-directory-urls` / `--no-directory-urls`	boolean	Use directory URLs when building pages (the default).	None
`-d`, `--site-dir`	path	The directory to output the result of the documentation build.	None
`-q`, `--quiet`	boolean	Silence warnings	`False`
`-v`, `--verbose`	boolean	Enable verbose output	`False`
`--help`	boolean	Show this message and exit.	`False`

get-deps

Show required PyPI packages inferred from plugins in mkdocs.yml.

Usage:

cli get-deps [OPTIONS]

Options:

Name	Type	Description	Default
`-v`, `--verbose`	boolean	Enable verbose output	`False`
`-f`, `--config-file`	filename	Provide a specific MkDocs config. This can be a file name, or '-' to read from stdin.	None
`-p`, `--projects-file`	text	URL or local path of the registry file that declares all known MkDocs-related projects.	None
`--help`	boolean	Show this message and exit.	`False`

gh-deploy

Deploy your documentation to GitHub Pages.

Usage:

cli gh-deploy [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--clean` / `--dirty`	boolean	Remove old files from the site_dir before building (the default).	`True`
`-m`, `--message`	text	A commit message to use when committing to the GitHub Pages remote branch. Commit {sha} and MkDocs {version} are available as expansions	None
`-b`, `--remote-branch`	text	The remote branch to commit to for GitHub Pages. This overrides the value specified in config	None
`-r`, `--remote-name`	text	The remote name to commit to for GitHub Pages. This overrides the value specified in config	None
`--force`	boolean	Force the push to the repository.	`False`
`--no-history`	boolean	Replace the whole Git history with one new commit.	`False`
`--ignore-version`	boolean	Ignore check that build is not being deployed with an older version of MkDocs.	`False`
`--shell`	boolean	Use the shell when invoking Git.	`False`
`-f`, `--config-file`	filename	Provide a specific MkDocs config. This can be a file name, or '-' to read from stdin.	None
`-s`, `--strict` / `--no-strict`	boolean	Enable strict mode. This will cause MkDocs to abort the build on any warnings.	None
`-t`, `--theme`	choice (`ledger` \| `material` \| `mkdocs` \| `readthedocs`)	The theme to use when building your documentation.	None
`--use-directory-urls` / `--no-directory-urls`	boolean	Use directory URLs when building pages (the default).	None
`-d`, `--site-dir`	path	The directory to output the result of the documentation build.	None
`-q`, `--quiet`	boolean	Silence warnings	`False`
`-v`, `--verbose`	boolean	Enable verbose output	`False`
`--help`	boolean	Show this message and exit.	`False`

new

Create a new MkDocs project.

Usage:

cli new [OPTIONS] PROJECT_DIRECTORY

Options:

Name	Type	Description	Default
`-q`, `--quiet`	boolean	Silence warnings	`False`
`-v`, `--verbose`	boolean	Enable verbose output	`False`
`--help`	boolean	Show this message and exit.	`False`

serve

Run the builtin development server.

Usage:

cli serve [OPTIONS]

Options:

Name	Type	Description	Default
`-a`, `--dev-addr`	text	IP address and port to serve documentation locally (default: localhost:8000)	None
`-o`, `--open`	boolean	Open the website in a Web browser after the initial build finishes.	`False`
`--no-livereload`	boolean	Disable the live reloading in the development server.	`False`
`--dirty`	text	Only re-build files that have changed.	`False`
`-c`, `--clean`	text	Build the site without any effects of `mkdocs serve` - pure `mkdocs build`, then serve.	`False`
`--watch-theme`	boolean	Include the theme in list of files to watch for live reloading. Ignored when live reload is not used.	`False`
`-w`, `--watch`	path	A directory or file to watch for live reloading. Can be supplied multiple times.	`[]`
`-f`, `--config-file`	filename	Provide a specific MkDocs config. This can be a file name, or '-' to read from stdin.	None
`-s`, `--strict` / `--no-strict`	boolean	Enable strict mode. This will cause MkDocs to abort the build on any warnings.	None
`-t`, `--theme`	choice (`ledger` \| `material` \| `mkdocs` \| `readthedocs`)	The theme to use when building your documentation.	None
`--use-directory-urls` / `--no-directory-urls`	boolean	Use directory URLs when building pages (the default).	None
`-q`, `--quiet`	boolean	Silence warnings	`False`
`-v`, `--verbose`	boolean	Enable verbose output	`False`
`--help`	boolean	Show this message and exit.	`False`