Skip to content

Deploy MkDocs

Deploy MkDocs #7

Workflow file for this run

name: Deploy MkDocs
on:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup Pages
uses: actions/configure-pages@v3
- uses: actions/setup-python@v4
with:
python-version: 3.x
- name: Setup dependencies
run: pip install --upgrade pip && pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin
- name: Build with MkDocs
run: |
mkdocs build -c -d _site
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ./_site
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2