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.

Run this command locally to deploy to Github Pages by building and pushing to gh-pages branch.

mkdocs gh-deploy

See options:

mkdocs gh-deploy --help

Note you cannot view the site before its pushed, so use the build or serve commands for that.