Skip to content
This repository was archived by the owner on Nov 22, 2025. It is now read-only.

Commit 6b286cb

Browse files
committed
Migrate to mkdocs material
1 parent ad1c4ea commit 6b286cb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+134
-21
lines changed

.github/workflows/deploy.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Deploy Github Pages
2+
on:
3+
push:
4+
branches:
5+
- main
6+
permissions:
7+
contents: write
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- name: Configure Git Credentials
14+
run: |
15+
git config user.name github-actions[bot]
16+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
17+
- uses: actions/setup-python@v5
18+
with:
19+
python-version: 3.x
20+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
21+
- uses: actions/cache@v4
22+
with:
23+
key: mkdocs-material-${{ env.cache_id }}
24+
path: .cache
25+
restore-keys: |
26+
mkdocs-material-
27+
- run: pip install mkdocs-material
28+
- run: mkdocs gh-deploy --force

.github/workflows/test-build.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Test mkdocs build
2+
on:
3+
pull_request:
4+
branches:
5+
- main
6+
jobs:
7+
build:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v4
11+
- uses: actions/setup-python@v5
12+
with:
13+
python-version: 3.x
14+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
15+
- uses: actions/cache@v4
16+
with:
17+
key: mkdocs-material-${{ env.cache_id }}
18+
path: .cache
19+
restore-keys: |
20+
mkdocs-material-
21+
- run: pip install mkdocs-material
22+
- run: mkdocs build

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.venv
2+
site

README.md

Lines changed: 2 additions & 16 deletions

_config.yml

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/README.md

Lines changed: 17 additions & 0 deletions

0 commit comments

Comments
 (0)