You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?

GitHub Action

Deploy MkDocs

1.4

GitHub Action to deploy an MkDocs site to GitHub Pages

This GitHub action will deploy your MkDocs site as GitHub Pages.

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