Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Deploy mkdocs-material to GitHub Pages
name: Deploy zensical site to GitHub Pages

on:
# Runs on pushes targeting the default branch
push:
branches:
- "main"
- main

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand All @@ -18,7 +18,7 @@ permissions:
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
group: pages
cancel-in-progress: false

jobs:
Expand All @@ -37,18 +37,18 @@ jobs:

- uses: actions/setup-python@v6
with:
python-version: '3.11'
cache: 'pip' # caching pip dependencies
python-version: "3.14"
cache: pip # caching pip dependencies

- run: pip install -r requirements.txt

- run: mkdocs build --verbose --site-dir public
- run: zensical build --clean

- name: Upload artifact
uses: actions/upload-pages-artifact@v4
with:
# Upload 'public' directory
path: 'public'
# Upload 'site' directory
path: site

- name: Deploy to GitHub Pages
id: deployment
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Validate mkdocs upon PR
name: Validate zensical site upon PR

on:
# Runs on PRs targeting the default branch
Expand All @@ -18,9 +18,15 @@ jobs:

- uses: actions/setup-python@v6
with:
python-version: '3.11'
cache: 'pip' # caching pip dependencies
python-version: "3.14"
cache: pip # caching pip dependencies

- run: pip install -r requirements.txt

- run: mkdocs build --verbose
- run: zensical build

- name: Upload artifact
uses: actions/upload-pages-artifact@v4
with:
# Upload 'site' directory
path: site
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.ignore
.cache
.venv
site/
5 changes: 1 addition & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
mkdocs-material[imaging]==9.7.1
mkdocs-git-revision-date-localized-plugin==1.5.1
mkdocs-git-committers-plugin-2==2.5.0
mkdocs-glightbox==0.5.2
zensical==0.0.21