feat: add README.md for annotation usage and examples #4
This file contains hidden or 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: Deploy MkDocs to GitHub Pages | |
on: | |
push: | |
branches: | |
- develop-mkdocs # Trigger this workflow on push to the develop branch | |
pull_request: | |
branches: | |
- develop-mkdocs # Also trigger on pull requests to the develop branch | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v2 | |
- name: Set up Python | |
uses: actions/setup-python@v2 | |
with: | |
python-version: '3.9' | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install mkdocs mkdocs-material | |
- name: Build the MkDocs site | |
run: mkdocs build | |
- name: Deploy to GitHub Pages | |
run: mkdocs gh-deploy --force | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |