skills.rest
natelandau
natelandauCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

zensical

Author and configure documentation sites with the Zensical static-site engine.

Updated May 9, 2026
Search Tags:#documentation#markdown#mermaid#technical writing#static site generator#mkdocs#zensical
One-click install
npx skills add https://github.com/natelandau/cc-plugin --skill zensical-natelandau
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: zensical
Source: https://github.com/natelandau/cc-plugin/tree/main/plugins/natelandau-toolkit/skills/zensical
Command: npx skills add https://github.com/natelandau/cc-plugin --skill zensical-natelandau

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing documentation with the Zensical static-site engine requires knowing its specific Markdown extensions, TOML configuration, and CLI commands, and plain Markdown output misses the rich elements that make docs readable. ## Core Features & Use Cases - Rich Markdown authoring: Write admonitions, Mermaid diagrams, content tabs, code annotations, card grids, icons, footnotes, and math using Zensical's extension syntax. - Project configuration: Set up zensical.toml with theme variants, color palettes, navigation, theme feature flags, and Markdown extensions, or migrate from mkdocs.yml. - CLI workflows: Scaffold projects with zensical new, preview with zensical serve, and build with zensical build. - Use Case: When asked to document a deployment workflow, produce a page with a Mermaid flowchart for the process, content tabs for macOS and Linux commands, and warning admonitions for destructive steps. ## Quick Start Use the zensical skill to write a docs page explaining our release process with a flowchart and per-OS install tabs.

Frequently Asked Questions about zensical

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a documentation site with Zensical?▼

Run zensical new mydocs to scaffold a project with a docs folder, zensical.toml config, and a GitHub Pages workflow. Then use zensical serve for a live-reload preview at localhost:8000 and zensical build to generate the static site.

How do I add Mermaid diagrams to Zensical Markdown pages?▼

Fence the diagram with the mermaid language tag in a code block, and Zensical initializes and themes the runtime automatically. Officially supported types are flowchart, sequence, state, class, and entity-relationship diagrams.

Can Zensical use an existing mkdocs.yml configuration?▼

Yes, Zensical natively reads legacy mkdocs.yml files, though new projects should use zensical.toml. Some mkdocs.yml settings like remote_branch, exclude_docs, and hooks are not yet supported.

Why does my Zensical admonition or content tab render as plain text?▼

The most common cause is indentation: content nested inside admonitions, tabs, list items, or footnotes must be indented four spaces. If indentation is correct, the required Markdown extension may not be enabled in zensical.toml.

What Markdown extensions does Zensical enable by default?▼

The zensical new defaults enable admonitions, code highlighting and annotation, content tabs, Mermaid, grids, icons, formatting, task lists, footnotes, and abbreviations via pymdownx extensions. Features like snippets and image captions require adding extensions manually.

Related Skills

Explore More Software Engineering Skills→
MovchanetsMovchanets

documentation

Generate documentation workflows and content plans for codebases and technical projects.

Community
Advanced
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate
withmartian-sandbox-darksidewithmartian-sandbox-darkside

writing-functional-docs

Generate structured functional documentation templates for user tasks and workflows.

Official
Intermediate
kettleofketchupkettleofketchup

zensical

Migrate mkdocs-material projects to Zensical and manage their documentation.

Community
Intermediate