zensical

What problem does it solve?

This Skill eliminates the friction of creating, customizing, and maintaining static documentation sites with Zensical, including migrating existing projects from mkdocs-material to the new TOML-based configuration system.

Core Features & Use Cases

• Project Setup & Configuration: Bootstrap new Zensical projects, configure zensical.toml settings, enable Markdown extensions, and choose between modern or classic theme variants.
• Content Authoring: Create rich documentation with admonitions, syntax-highlighted code blocks, content tabs, responsive grids, icons, Mermaid diagrams, and math rendering.
• Publishing & CI/CD: Deploy documentation to GitHub Pages or GitLab Pages, and integrate Zensical build steps into existing CI/CD pipelines.
• Use Case: A developer maintaining an open source project's documentation can use this Skill to migrate an existing mkdocs-material site to Zensical, add custom branding and interactive content, and set up automated publishing on every push to the main branch.

Quick Start

Use the zensical skill to migrate your existing mkdocs.yml configuration to zensical.toml and set up a GitHub Pages deployment workflow for your documentation project.