Skip to content

Switch from Material for MkDocs to Zensical#27

Merged
ryanlua merged 32 commits intomainfrom
zensical
Mar 6, 2026
Merged

Switch from Material for MkDocs to Zensical#27
ryanlua merged 32 commits intomainfrom
zensical

Conversation

@ryanlua
Copy link
Owner

@ryanlua ryanlua commented Mar 6, 2026

Migrates the documentation from Material for MkDocs to Zensical.

MkDocs version 2 is bleak, and Material for MkDocs is no longer maintained. It's a good time to migrate to alternatives.

ryanlua added 27 commits March 1, 2026 10:05
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
@ryanlua ryanlua self-assigned this Mar 6, 2026
@ryanlua ryanlua added the documentation Improvements or additions to documentation label Mar 6, 2026
Signed-off-by: GitHub <noreply@github.com>
@ryanlua ryanlua marked this pull request as ready for review March 6, 2026 09:08
Copilot AI review requested due to automatic review settings March 6, 2026 09:08
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Migrates the documentation site from MkDocs Material (mkdocs.yml) to Zensical (zensical.toml) and updates the CI/CD + dev tooling accordingly to build/deploy via GitHub Pages.

Changes:

  • Replace MkDocs Material configuration with a new zensical.toml config and adjust markdown pages for Zensical (page front matter/icons).
  • Update GitHub Actions docs workflow to build with zensical build --clean and deploy via GitHub Pages actions.
  • Remove MkDocs-related editor/devcontainer settings and replace docs assets (favicon/logo) with purse.svg.

Reviewed changes

Copilot reviewed 14 out of 18 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
zensical.toml New Zensical site configuration (nav/theme/features/markdown extensions).
mkdocs.yml Removes legacy MkDocs Material configuration.
docs/index.md Adds page front matter for Zensical icon metadata.
docs/installation.md Adds front matter and adjusts section heading formatting.
docs/guide.md Adds front matter for icon metadata.
docs/performance.md Adds front matter for icon metadata.
docs/philosophy.md Adds front matter for icon metadata.
docs/api-reference.md Adds front matter (title + icon).
docs/assets/purse.svg Adds new SVG asset used as logo/favicon.
docs/assets/logo.svg Removes old logo asset.
docs/assets/favicon.svg Removes old favicon asset.
.vscode/settings.json Removes MkDocs YAML schema/custom tags config.
.vscode/extensions.json Removes YAML extension recommendation; keeps Luau tooling.
.gitignore Renames MkDocs-specific ignore comment to generic docs wording.
.github/workflows/docs.yml Switches from mkdocs gh-deploy to Zensical build + Pages deploy workflow.
.github/workflows/ci.yml Minor formatting/whitespace normalization in steps.
.github/workflows/release.yml Minor formatting/whitespace normalization in steps and tag pattern quoting.
.devcontainer/devcontainer.json Replaces MkDocs install with Zensical install; updates forwarded port label.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ryanlua added 4 commits March 6, 2026 09:42
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
@ryanlua ryanlua merged commit 0705aff into main Mar 6, 2026
4 checks passed
@ryanlua ryanlua deleted the zensical branch March 6, 2026 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants