From 0aa6e5653648fc2f40569ff4ed4dbfeaf11dfc16 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Mon, 30 Nov 2015 17:31:40 -0500 Subject: [PATCH] Document the `--help` flag. As of 40dc17e17e5, any mention of the `--help` flag had been removed from the documentation. A breif summary has been added here. However, the output of `--help` has not been included as that can change in the future and updating the docs every time a option is updated become unnesecarily duplicative (as the command line is self-documenting). This fixes #767. --- docs/index.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/index.md b/docs/index.md index 2e45a4b8..5c24582c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -199,6 +199,23 @@ with the `--clean` switch. mkdocs build --clean ``` +## Other Commands and Options + +There are various other commands and options available. For a complete list of +commands, use the `--help` flag: + +```bash +mkdocs --help +``` + +To view a list of options available on a given command, use the `--help` flag +with that command. For example, to get a list of all options available for the +`build` command run the following: + +```bash +mkdocs build --help +``` + ## Deploying The documentation site that we've just built only uses static files so you'll be