Skip to content

Use native zensical.toml config and enable Zensical features - #99

Merged
jefftriplett merged 2 commits into
mainfrom
zensical-toml-config
Aug 14, 2026
Merged

jefftriplett merged 2 commits into
mainfrom
zensical-toml-config

Conversation

@jefftriplett

Copy link
Copy Markdown
Member

Follows up the MkDocs→Zensical port (#98) by moving from the compatibility mkdocs.yml to a native zensical.toml config, which unlocks Zensical's richer feature set.

URL safety

Built the site from zensical.toml and diffed against the mkdocs.yml build: identical 101-page URL set — no links, bookmarks, or SEO change. Clean build (No issues found).

Changes

  • Add zensical.toml, remove mkdocs.yml: nav, Django-green custom palette, extra_css, repo info.
  • Enable Zensical features: admonitions, superfences + Mermaid diagrams, code copy/annotate/select, content tabs, footnote & content tooltips, instant navigation + prefetch, section grouping, search highlight/suggest, and header anchor links (toc.permalink).
  • Fix active nav-link contrast in dark mode (accent green on the slate background — the dark green was unreadable).

Notes

  • Zensical has native search, so the old plugins: search is dropped.
  • Build still outputs to ./site; deploy workflow and cname are unchanged. The PR build check validates it before merge.

Replace mkdocs.yml with a native zensical.toml config. Verified the generated
URL set is identical to the mkdocs.yml build (101 pages), so no links change.

- zensical.toml: nav, Django-green custom palette, extra_css, repo info
- enable Zensical features: admonitions, superfences + mermaid, code
  copy/annotate/select, content tabs, footnote/content tooltips, instant
  navigation + prefetch, section grouping, search highlight/suggest, header
  anchor links (toc.permalink)
- fix active nav link contrast in dark mode (accent green on slate)
The active nav item used the dark Django green, which is unreadable on the
slate dark-mode background. Use the light accent green in dark mode.
@jefftriplett
jefftriplett merged commit ea7c449 into main Aug 14, 2026
1 check passed
@jefftriplett
jefftriplett deleted the zensical-toml-config branch August 14, 2026 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant