mkdocs-quickstart/docs/deploy.md

Deploy

How to deploy a MkDocs site

See Deploying Your Docs on the Mkdocs site for more details.

Github Pages

Note this is for a Project Page and not Organization and User Pages.

How to deploy to Github Pages.

Run this to build to site directory, push to gh-pages branch and enable Github Pages (if it was not yet enabled). The default option is to clean the site directory first.

mkdocs gh-deploy

Then go to your repo on Github, see the environment tab and click View deployment.

e.g.

• michaelcurrin.github.io/mkdocs-quickstart/

See deploy options:

mkdocs gh-deploy --help