You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
MkDocs Action
v0.5.0
GitHub Actions for MkDocs
Default: 'latest'
The version of pip, MkDocs.
Default: requirements.txt
The path to requirements.txt
Default: mkdocs.yml
The path to mkdocs.yml
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- 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.