Skip to content

Commit 1ac2086

Browse files
authored
Create build_pages.yml
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/
1 parent 6b8919a commit 1ac2086

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

.github/workflows/build_pages.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Based on: https://blog.elmah.io/deploying-a-mkdocs-documentation-site-with-github-actions/
2+
name: build
3+
on:
4+
push:
5+
branches:
6+
- main
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: actions/setup-python@v2
13+
with:
14+
python-version: 3.x
15+
- name: Setup MkDocs
16+
run: |
17+
pip install mkdocs-material
18+
pip install mkdocs-git-revision-date-localized-plugin
19+
pip install mike
20+
- name: Build website
21+
run: mkdocs gh-deploy --verbose

0 commit comments

Comments
 (0)