Deploy MkDocs

Deploy MkDocs documentation to GitHub Pages with versioning support

Usage

- uses: serapeum-org/github-actions/actions/mkdocs-deploy@mkdocs/v1
  with:
    trigger: # required
    package-manager: 'uv'
    python-version: '3.12'
    install-groups: 'groups: docs'
    deploy-token: # required
    release-tag: ''
    mike-alias: 'latest'
    notebooks-path: ''
    notebooks-exclude: ''
    notebooks-continue-on-error: 'false'

Inputs

Input	Description	Required	Default
trigger	Deployment trigger type that determines which mike version to deploy	Yes	-
package-manager	Package manager to use for setting up the Python environment	No	uv
python-version	Python version to install (passed to the selected python-setup action)	No	3.12
install-groups	Dependency groups or environment to install	No	groups: docs
deploy-token	GitHub token for deployment to GitHub Pages	Yes	-
release-tag	Release tag version (used only with trigger "release")	No	-
mike-alias	Mike alias to assign to release versions	No	latest
notebooks-path	Root directory containing notebooks to execute and cache before the mkdocs build	No	-
notebooks-exclude	Newline- or comma-separated glob patterns identifying notebooks under notebooks-path to skip executing	No	-
notebooks-continue-on-error	When "true", a non-excluded notebook that fails to execute is downgraded to a warning and the remaining notebooks still run, instead of aborting the whole "Prepare notebook outputs" step	No	false