Update options and quickstart documentation #11
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: MkDocs Build and Deploy | |
on: | |
push: | |
branches: main | |
workflow_dispatch: | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: 3.x | |
- uses: actions/cache@v3 | |
with: | |
key: ${{ github.ref }} | |
path: site | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install mkdocs mkdocs-material | |
- name: Build static files | |
run: mkdocs build | |
- name: Building gh-pages repo | |
working-directory: site | |
run: | | |
git init -b gh-pages | |
git config --global user.email "[email protected]" | |
git config --global user.name "github-actions" | |
git add -A | |
git commit -m "Update static files" | |
- name: Pushing static files | |
uses: ad-m/github-push-action@master | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
branch: gh-pages | |
directory: site | |
force: true |