4fff318ea9
- Update MkDocs configuration with new features and plugins - Add deployment guide for documentation - Restructure documentation navigation and index page - Create GitHub Actions workflow for automatic documentation deployment - Fix typos in site URLs and configuration
38 lines
942 B
YAML
38 lines
942 B
YAML
name: Deploy MkDocs
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
- master
|
|
|
|
permissions:
|
|
contents: write
|
|
|
|
jobs:
|
|
deploy:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Setup Python
|
|
uses: actions/setup-python@v4
|
|
with:
|
|
python-version: '3.x'
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
python -m pip install --upgrade pip
|
|
pip install mkdocs-material
|
|
pip install mkdocs-minify-plugin
|
|
pip install mkdocs-git-revision-date-plugin
|
|
pip install mkdocs-mkdocstrings
|
|
pip install mkdocs-social-plugin
|
|
pip install mkdocs-redirects
|
|
|
|
- name: Deploy
|
|
run: |
|
|
git config --global user.name "github-actions[bot]"
|
|
git config --global user.email "github-actions[bot]@users.noreply.github.com"
|
|
mkdocs gh-deploy --force |