Skip to content

Commit c9748c0

Browse files
committed
try dropping in zensical to replace material for mkdocs
1 parent 730a8c3 commit c9748c0

4 files changed

Lines changed: 30 additions & 26 deletions

File tree

.github/workflows/docs.yml

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,41 @@ on:
44
branches:
55
- master
66
permissions:
7-
contents: write
7+
contents: read
8+
pages: write
9+
id-token: write
810
jobs:
911
deploy:
12+
environment:
13+
name: github-pages
14+
url: ${{ steps.deployment.outputs.page_url }}
1015
runs-on: ubuntu-latest
1116
defaults:
1217
run:
1318
working-directory: ./documentation
1419
steps:
15-
- uses: actions/checkout@v4
16-
- name: Configure Git Credentials
17-
run: |
18-
git config user.name github-actions[bot]
19-
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
20+
- uses: actions/configure-pages@v5
21+
- uses: actions/checkout@v5
2022
- uses: actions/setup-python@v5
2123
with:
2224
python-version: 3.x
23-
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
24-
- uses: actions/cache@v4
25-
with:
26-
key: mkdocs-material-${{ env.cache_id }}
27-
path: .cache
28-
restore-keys: |
29-
mkdocs-material-
25+
# Zensical recommends no caching for the moment
26+
# - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
27+
# - uses: actions/cache@v4
28+
# with:
29+
# key: mkdocs-material-${{ env.cache_id }}
30+
# path: .cache
31+
# restore-keys: |
32+
# mkdocs-material-
3033
- run: |
3134
sudo apt-get update
3235
sudo apt-get install -y zsh
3336
- run: make johanndoc
3437
working-directory: ./
35-
- run: pip install mkdocs-material mkdocs-minify-plugin
36-
- run: mkdocs gh-deploy --force
38+
- run: pip install zensical
39+
- run: zensical build --clean
40+
- uses: actions/upload-pages-artifact@v4
41+
with:
42+
path: site
43+
- uses: actions/deploy-pages@v4
44+
id: deployment

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ not_quite_lisp: not_quite_lisp.jn bin/jnc lib/jstdlib.o
2020
# utility targets
2121

2222
mkdocs:
23-
docker run --rm -it -p 8000:8000 -v ${PWD}/documentation:/docs squidfunk/mkdocs-material
23+
docker run --rm -it -p 8000:8000 -v ${PWD}/documentation:/docs zensical/zensical
2424

2525
johanndoc:
2626
./johanndoc.sh

documentation/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
site_name: Johann
2-
copyright: Copyright &copy; 2025 <a href="https://github.com/barneyb">Barney Boisvert</a>
2+
copyright: Copyright &copy; 2026 <a href="https://github.com/barneyb">Barney Boisvert</a>
33
site_url: https://barneyb.github.io/johann
44
repo_url: https://github.com/barneyb/johann
55
repo_name: barneyb/johann
@@ -40,7 +40,7 @@ theme:
4040
logo: material/music-rest-quarter
4141
favicon: images/rest.png
4242
palette:
43-
# Why primary/accept need to be declared thrice is completely unclear.
43+
# Why primary/accent need to be declared thrice is completely unclear.
4444
- media: "(prefers-color-scheme)"
4545
primary: light green
4646
accent: light green

documentation/overrides/partials/copyright.html

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,10 @@
88
<div class="generator">
99
Made with
1010
<a
11-
href="https://www.mkdocs.org/"
12-
target="_blank" rel="noopener"
13-
>MkDocs</a>
14-
and
15-
<a
16-
href="https://squidfunk.github.io/mkdocs-material/"
17-
target="_blank" rel="noopener"
18-
>Material</a>
11+
href="https://zensical.org/"
12+
target="_blank"
13+
rel="noopener"
14+
>Zensical</a>
1915
</div>
2016
{% endif %}
2117
</div>

0 commit comments

Comments
 (0)