Skip to content

Commit

Permalink
Create build_pages.yml
Browse files Browse the repository at this point in the history
Created github action to deploy MkDocs automatically upon push to the main branch.
Instructions taken from: https://blog.elmah.io/deploying-a-mkdocs-documentation-site-with-github-actions/
  • Loading branch information
jgebal authored Feb 20, 2024
1 parent 6b8919a commit 1ac2086
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/build_pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Based on: https://blog.elmah.io/deploying-a-mkdocs-documentation-site-with-github-actions/
name: build
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v2
with:
python-version: 3.x
- name: Setup MkDocs
run: |
pip install mkdocs-material
pip install mkdocs-git-revision-date-localized-plugin
pip install mike
- name: Build website
run: mkdocs gh-deploy --verbose

0 comments on commit 1ac2086

Please sign in to comment.