mkdocs gh-deploy
Deploy your documentation to GitHub Pages
Options
| Name | Description |
|---|---|
-h, --help | help for gh-deploy |
-q, --quiet | Silence warnings |
-v, --verbose | Enable verbose output |
-f, --config-file <arg> | Provide a specific MkDocs config |
-s, --strict | Enable strict mode. This will cause MkDocs to abort the build on any warnings |
-t, --theme <theme> | The theme to use when building your documentation |
--use-directory-urls | Use directory URLs when building pages (the default) |
--no-directory-urls | Don't use directory URLs when building pages |
-c, --clean | Remove old files from the site directory before building (the default) |
--dirty | Only rebuild pages that have been modified since last build |
-m, --message <message> | A commit message to use when committing to the GitHub Pages remote branch. Commit {sha} and MkDocs {version} are available as expansions |
-b, -remote-branch <branch name> | The remote branch to commit to for GitHub Pages. This overrides the value specified in config |
-r, --remote-name <remote name> | The remote name to commit to for GitHub Pages. This overrides the value specified in config |
--force |
|
--no-history |
|
--ignore-version | Ignore check that build is not being deployed with an older version of MkDocs |
--shell | Use the shell when invoking Git |