Skip to content

Commit 28dc56b

Browse files
committed
Add MkDocs GitHub Pages workflow
1 parent 9b826c0 commit 28dc56b

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

.github/workflows/mkdocs.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Deploy MkDocs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master # change to main later if you rename
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: true
16+
17+
jobs:
18+
deploy:
19+
runs-on: ubuntu-latest
20+
21+
steps:
22+
- name: Checkout repository
23+
uses: actions/checkout@v4
24+
25+
- name: Set up Python
26+
uses: actions/setup-python@v5
27+
with:
28+
python-version: '3.x'
29+
30+
- name: Install MkDocs
31+
run: |
32+
pip install mkdocs mkdocs-material
33+
34+
- name: Build site
35+
run: mkdocs build
36+
37+
- name: Upload Pages artifact
38+
uses: actions/upload-pages-artifact@v3
39+
with:
40+
path: site
41+
42+
- name: Deploy to GitHub Pages
43+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)