joshooaj/mkdocs-deploy

Build and deploy docs to GitHub Pages with MkDocs

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stalelast commit Mar 21, 2024
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: joshooaj/mkdocs-deploy@81e3328f726b6b2aca60461b9a845c2a6bea65a8 # no releases — HEAD as of 2026-07-11

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
config_file	MkDocs config file name. Usually "mkdocs.yml". If not provided, a simple config file will be generated and used during workflow execution.	no	—
requirements_file	File name for Python package requirements.	no	—
site_name	Site name, used in header, title and drawer.	no	—
site_url	Site url. Default value is https://owner.github.io/repository-name/. Ignored when using config.	no	—
repo_name	Name of the MkDocs theme to use. This value is ignored when a value is provided for "config".	no	—
docs_dir	Path to the root of your MkDocs site. Usually "docs/". This value is ignored when a value is provided for "config".	no	docs
remote_branch	Branch to use when publishing GitHub Pages site.	no	gh-pages
theme	Name of the MkDocs theme to use. This value is ignored when a value is provided for "config".	no	material
deploy	Set to "false" if you want to execute "mkdocs build" instead of "mkdocs gh-deploy". You might do this to validate the site builds successfully, or when building the site and publishing it somewhere other than GitHub Pages.	—	true

Outputs

name	description
mkdocs-config	mkdocs configuration file