Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
arrow-up-circle

GitHub Action

Deploy MkDocs

1.9

Deploy MkDocs

arrow-up-circle

Deploy MkDocs

Deploys MkDocs site

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Deploy MkDocs

              
  uses: mhausenblas/mkdocs-deploy-gh-pages@1.9
Learn more about this action in mhausenblas/mkdocs-deploy-gh-pages

Choose a version

GitHub Action to deploy an MkDocs site to GitHub Pages

GitHub Badge

This GitHub action will deploy your MkDocs site as GitHub Pages, using the Metal theme. It assumes that an mkdocs.yml file is present in the top-level directory and the source files (Markdown, etc.) are in the docs/ folder.

Before you start, make sure you enable GitHub pages via the repo settings.

Example usage

name: Publish docs via GitHub Pages
on:
  push:
    branches:
      - master

jobs:
  build:
    name: Deploy docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout master
        uses: actions/checkout@v1

      - name: Deploy docs
        uses: mhausenblas/mkdocs-deploy-gh-pages@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}