mkdocs gh-deploy

help

執行

$ mkdocs gh-deploy --help

顯示

Usage: mkdocs gh-deploy [OPTIONS]

  Deploy your documentation to GitHub Pages

Options:
  -c, --clean                 Remove old files from the site_dir before
                              building
  -f, --config-file FILENAME  Provide a specific MkDocs config
  -m, --message TEXT          A commit message to use when commiting to the
                              Github Pages remote branch
  -b, --remote-branch TEXT    The remote branch to commit to for Github Pages.
                              This overrides the value specified in config
  -r, --remote-name TEXT      The remote name to commit to for Github Pages.
                              This overrides the value specified in config
  -q, --quiet                 Silence warnings
  -v, --verbose               Enable verbose output
  -h, --help                  Show this message and exit.