Skip to content

Commit

Permalink
adding github action to publish mkdocs as github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
unmarshall committed Nov 7, 2024
1 parent 3374fb1 commit 75848bb
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/public-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Publish docs via Github pages
on:
push:
branches:
- master
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout master
uses: actions/checkout@4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install \
mkdocs-material \
pymdown-extensions \
mkdocs-glightbox \
mkdocs-pymdownx-material-extras
- run: mkdocs gh-deploy --force

0 comments on commit 75848bb

Please sign in to comment.