README.md

actions-mkdocs

GitHub Actions for MkDocs

Inputs

mkdocs_version

Default: 'latest'

The version of pip, MkDocs.

requirements

Default: requirements.txt

The path to requirements.txt

configfile

Default: mkdocs.yml

The path to mkdocs.yml

Example usage

name: Deploy
on:
  push:
    branches:
      - main
jobs:
  build:
    name: Deploy docs to GitHub Pages
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 
        uses: actions/checkout@v2
      - name: Build
        uses: Tiryoh/actions-mkdocs@v0
        with:
          mkdocs_version: 'latest' # option
          #mkdocs_version: '1.1' # option
          requirements: 'requirements.txt' # option
          configfile: 'mkdocs.yml' # option
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./site

Related projects

• Tiryoh/docker-mkdocs-builder
  • Dockerfile that just builds the MkDocs document
• squidfunk/mkdocs-material
  • A Material Design theme for MkDocs, this project includes build & deploy Dockerfile
• peaceiris/actions-gh-pages
  • GitHub Actions for GitHub Pages rocket Deploy static files and publish your site easily. Static-Site-Generators-friendly.

License

Copyright (c) 2020-2021 Daisuke Sato

This repository is licensed under the MIT License, see LICENSE. Unless attributed otherwise, everything in this repository is licensed under the MIT license.

Acknowledgements

This repository includes third-party libraries and software. See THIRD-PARTY-NOTICES.md.