Skip to content

website: migrate from mkdocs to zensical - #881

Merged
winiciusallan merged 1 commit into
k-orc:mainfrom
shiftstack:zensical
Aug 19, 2026
Merged

website: migrate from mkdocs to zensical#881
winiciusallan merged 1 commit into
k-orc:mainfrom
shiftstack:zensical

Conversation

@mandre

@mandre mandre commented Aug 14, 2026

Copy link
Copy Markdown
Collaborator

Replace mkdocs-material with zensical, since mkdocs v1 is no longer maintained.

Depends on #880.

@github-actions github-actions Bot added the semver:patch No API change label Aug 14, 2026

@winiciusallan winiciusallan left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow! The website looks great. I've left a few comments, but nothing blocking.

Comment thread website/requirements.txt Outdated
Comment thread website/post-build.sh
Comment thread website/mkdocs.yml Outdated

@winiciusallan winiciusallan left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like zensical builds the website into the site directory. Let's add website/site to .gitignore so we avoid stashing it.

@mandre

mandre commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator Author

It looks like zensical builds the website into the site directory. Let's add website/site to .gitignore so we avoid stashing it.

I looked it up and noticed also had a site directory locally. However, I'm now trying with zensical v0.0.56 and can confirm it honors the site_dir setting and is using rendered.

Replace mkdocs-material with zensical, since mkdocs v1 is no longer
maintained. Zensical reads mkdocs.yml natively, so no config format
conversion is needed.

- Replace mkdocs-material, mkdocs-minify-plugin, mkdocs-redirects with
  zensical in requirements.txt
- Remove unsupported plugin configs (minify, redirects) and hooks from
  mkdocs.yml; add site_dir: rendered
- Add website/post-build.sh to generate redirect HTML pages and the
  Plausible analytics proxy endpoint, replacing the mkdocs-redirects
  plugin and hooks.py respectively
- Delete hooks.py (superseded by post-build.sh)
- Update CI workflow to use zensical build and run the post-build script
@winiciusallan
winiciusallan added this pull request to the merge queue Aug 19, 2026
Merged via the queue into k-orc:main with commit c919e42 Aug 19, 2026
12 checks passed
@winiciusallan
winiciusallan deleted the zensical branch August 19, 2026 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

semver:patch No API change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants