mkdocs-quickstart/docs/tutorial/deploy.md

Deploy

Build and deploy to a remote public site

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

Github Pages

How to deploy your docs site to Github Pages.

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

Run deploy command

MkDocs needs to know where to publish commits on Github - so make sure you are working with a repo that you cloned, or that you initialize the local repo and add a remote repo.

Run this command locally:

mkdocs gh-deploy

That will do the following:

1. Clean and build to site directory.
2. Push to gh-pages branch. Note: You must not edit this branch directly.
3. Enable Github Pages if it was not yet enabled

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

Remote build

How to trigger a rebuild of your docs site on changes

When you make changes to your docs config or the docs directory, especially editing on Github directly, it's often useful to have the docs site build and deploy without you running a command. A remote build also means you not need to setup Python or MkDocs on your local machine just to get the docs site to work.

So setup a Github Action such as this to your project.

• deploy-mkdocs action in marketplace.