Deploy MkDocs action

Marketplace:

• deploy-mkdocs action.

This action will install MkDocs and the Material theme and deploy to GH Pages for you. You don’t need to specify or install any requirements.

Warning: on the release of tag 1.15, this action only deploys a configured material theme and fails on mkdocs or readthedocs as theme choices.

See the shell steps in action.sh script.

The author made a template repo - mhausenblas/mkdocs-template.

Usage

Example based on the one in the action’s docs:

• main.yml

    name: Deploy docs
  
    on:
      push:
        branches:
          - master
  
    jobs:
      build:
        name: Build
          
        runs-on: ubuntu-latest
  
        steps:
          - name: Checkout master
            uses: actions/checkout@v1
  
          - name: Deploy to GH Pages
            uses: mhausenblas/mkdocs-deploy-gh-pages@master
            env:
              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  

The env section also allows:

CUSTOM_DOMAIN: optionaldomain.com