Skip to content

Update README.md

Update README.md #3

Workflow file for this run

name: ci-mkdocs
on:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- name: Cache dependencies 📚
uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- name: Move Config 📝
run: mv ./docs/mkdocs.yml .
- name: Install dependencies 📦
run: pip install \
mkdocs-material \
mkdocs-minify-plugin \
mkdocs-redirects
- name: Deploy documentation 🚀
run: mkdocs gh-deploy --force