# zudo-doc

> Documentation base framework built with Astro and MDX.

## Docs

- [Getting Started](/pj/zudo-doc/docs/getting-started): Welcome to the Getting Started section. Choose a topic below to begin.
- [0.1.0](/pj/zudo-doc/docs/changelog/0.1.0): Initial release of zudo-doc.
- [Basic Components](/pj/zudo-doc/docs/components/basic-components): Standard Markdown and MDX typography elements available in documentation pages.
- [Develop](/pj/zudo-doc/docs/develop): Development notes for zudo-doc itself.
- [Introduction](/pj/zudo-doc/docs/getting-started/introduction): Learn what zudo-doc is, its features, and how it works.
- [Configuration](/pj/zudo-doc/docs/guides/configuration): Global settings and configuration reference for zudo-doc.
- [Guides](/pj/zudo-doc/docs/guides): Explore our guides to learn about zudo-doc features and customization.
- [Demo: Hide Sidebar](/pj/zudo-doc/docs/guides/layout-demos/hide-sidebar): Live demonstration of the hide_sidebar frontmatter option.
- [Design System](/pj/zudo-doc/docs/reference/design-system): zudo-doc's tight token strategy — spacing, typography, colors, and more.
- [/CLAUDE.md](/pj/zudo-doc/docs/claude-md/root): CLAUDE.md at /CLAUDE.md
- [Admonitions](/pj/zudo-doc/docs/components/admonitions): Callout blocks for highlighting important information with five distinct types.
- [Components](/pj/zudo-doc/docs/components): Available components and content features for use in MDX documentation files.
- [Generator CLI Testing](/pj/zudo-doc/docs/develop/generator-cli-testing): How to test the create-zudo-doc generator CLI with Claude Code skills.
- [Installation](/pj/zudo-doc/docs/getting-started/installation): How to install and set up zudo-doc for local development.
- [Frontmatter](/pj/zudo-doc/docs/guides/frontmatter): Complete reference for all available frontmatter fields in zudo-doc documents.
- [Demo: Hide Table of Contents](/pj/zudo-doc/docs/guides/layout-demos/hide-toc): Live demonstration of the hide_toc frontmatter option.
- [Component First Strategy](/pj/zudo-doc/docs/reference/component-first): Why zudo-doc uses components with utility classes instead of custom CSS class names.
- [Setup Preset Generator](/pj/zudo-doc/docs/getting-started/setup-preset-generator): Interactive helper to generate setup presets for create-zudo-doc.
- [/e2e/CLAUDE.md](/pj/zudo-doc/docs/claude-md/e2e): CLAUDE.md at /e2e/CLAUDE.md
- [Tabs](/pj/zudo-doc/docs/components/tabs): Tabbed content panels for showing alternatives like package managers or platform-specific instructions.
- [Link Checker](/pj/zudo-doc/docs/develop/link-checker): Post-build broken link checker that validates internal links in built HTML and MDX source files.
- [Writing Docs](/pj/zudo-doc/docs/getting-started/writing-docs): How to create and organize documentation pages in zudo-doc.
- [Demo: Hide Sidebar & Table of Contents](/pj/zudo-doc/docs/guides/layout-demos/hide-both): Live demonstration of combining hide_sidebar and hide_toc for a centered reading layout.
- [Sidebar](/pj/zudo-doc/docs/guides/sidebar): How the sidebar navigation is structured and configured.
- [Color](/pj/zudo-doc/docs/reference/color): zudo-doc's three-tier color strategy, palette system, color schemes, and customization.
- [Reference](/pj/zudo-doc/docs/reference): Technical reference for zudo-doc's components, design system, and color architecture.
- [How to Structure Navigations](/pj/zudo-doc/docs/getting-started/structuring-navigations): Best practices for organizing header navigation and sidebar categories
- [/packages/ai-chat-worker/CLAUDE.md](/pj/zudo-doc/docs/claude-md/packages--ai-chat-worker): CLAUDE.md at /packages/ai-chat-worker/CLAUDE.md
- [Details](/pj/zudo-doc/docs/components/details): Collapsible content sections using the HTML details/summary pattern.
- [Contribution](/pj/zudo-doc/docs/getting-started/contribution): How to contribute to zudo-doc, and the project's background and maintenance approach.
- [Header Navigation](/pj/zudo-doc/docs/guides/header-navigation): Configure header navigation tabs with optional nested dropdown menus
- [Sidebar Filter](/pj/zudo-doc/docs/guides/sidebar-filter): How the real-time sidebar filter works and how to configure it.
- [CJK-Friendly Markdown](/pj/zudo-doc/docs/reference/cjk-friendly): Fix bold/italic rendering near CJK punctuation
- [Header Right Items](/pj/zudo-doc/docs/guides/header-right-items): Configure the right-side cluster of the site header with a data-driven array of actions.
- [/packages/create-zudo-doc/CLAUDE.md](/pj/zudo-doc/docs/claude-md/packages--create-zudo-doc): CLAUDE.md at /packages/create-zudo-doc/CLAUDE.md
- [Math Equations](/pj/zudo-doc/docs/components/math-equations): KaTeX math equation support for inline, block, and fenced code block math.
- [Site Search](/pj/zudo-doc/docs/guides/search): How search works in zudo-doc and how to configure it.
- [Tags](/pj/zudo-doc/docs/guides/tags): Cross-cutting navigation for documentation pages.
- [AI Assistant API](/pj/zudo-doc/docs/reference/ai-assistant-api): API specification for the AI assistant chat endpoint.
- [Tag Governance](/pj/zudo-doc/docs/guides/tag-governance): Scale tagging from a handful of pages to hundreds by curating a vocabulary and enforcing it at build time.
- [Tag Audit](/pj/zudo-doc/docs/guides/tags-audit): Inspect every frontmatter tag against the project vocabulary — unknowns, deprecations, aliases, near-duplicates, and orphans.
- [Tag Suggestions](/pj/zudo-doc/docs/guides/tags-suggest): Opt-in local-LLM suggester that proposes up to three canonical tags for a doc from the project vocabulary.
- [Footer Taglist](/pj/zudo-doc/docs/guides/footer-taglist): Surface the tag vocabulary to readers via an opt-in column block in the site footer.
- [/packages/doc-history-server/CLAUDE.md](/pj/zudo-doc/docs/claude-md/packages--doc-history-server): CLAUDE.md at /packages/doc-history-server/CLAUDE.md
- [Mermaid Diagrams](/pj/zudo-doc/docs/components/mermaid-diagrams): Mermaid diagram support for flowcharts, sequence diagrams, and more.
- [Document History](/pj/zudo-doc/docs/guides/doc-history): View git revision history and line-by-line diffs for each documentation page.
- [AI Chat Worker (Cloudflare)](/pj/zudo-doc/docs/reference/ai-chat-worker): Standalone Cloudflare Worker that provides an AI chat API endpoint, independent of the Astro documentation site.
- [Body Foot Util Area](/pj/zudo-doc/docs/guides/body-foot-util-area): The right-aligned strip below every doc page that hosts the Document History trigger and the "View source on GitHub" link.
- [/packages/search-worker/CLAUDE.md](/pj/zudo-doc/docs/claude-md/packages--search-worker): CLAUDE.md at /packages/search-worker/CLAUDE.md
- [SiteTreeNav](/pj/zudo-doc/docs/components/site-tree-nav): A sitemap-like grid component that displays the full documentation tree with expandable categories.
- [Internationalization (i18n)](/pj/zudo-doc/docs/guides/i18n): Add multi-language support to your documentation
- [Frontmatter Preview](/pj/zudo-doc/docs/reference/frontmatter-preview): Automatically display custom frontmatter fields as a metadata table beneath the page title.
- [/src/CLAUDE.md](/pj/zudo-doc/docs/claude-md/src): CLAUDE.md at /src/CLAUDE.md
- [CategoryNav](/pj/zudo-doc/docs/components/category-nav): An Astro component that renders a grid of child page cards for category index pages.
- [Claude Code Resources](/pj/zudo-doc/docs/guides/claude-resources): Auto-generate documentation from your Claude Code resources.
- [llms.txt](/pj/zudo-doc/docs/guides/llms-txt): Auto-generate llms.txt and llms-full.txt files for AI-consumable documentation
- [Design Token Panel](/pj/zudo-doc/docs/reference/design-token-panel): Interactive tabbed panel for live-tweaking spacing, font, size, and color tokens — plus a JSON export/import workflow you can hand to an AI.
- [/src/config/CLAUDE.md](/pj/zudo-doc/docs/claude-md/src--config): CLAUDE.md at /src/config/CLAUDE.md
- [CategoryTreeNav](/pj/zudo-doc/docs/components/category-tree-nav): An Astro component that renders a nested tree of child page links for category index pages.
- [HtmlPreview](/pj/zudo-doc/docs/components/html-preview): Interactive HTML/CSS preview with viewport switching and collapsible source code display.
- [Documentation Skill Symlinker](/pj/zudo-doc/docs/guides/doc-skill-symlinker): Turn your zudo-doc documentation into a Claude Code knowledge base via a symlinked skill.
- [Versioning](/pj/zudo-doc/docs/guides/versioning): Maintain multiple versions of documentation with version-prefixed URLs and a version switcher
- [Changelog](/pj/zudo-doc/docs/changelog): Release notes and version history for zudo-doc.
- [/vendor/design-token-lint/CLAUDE.md](/pj/zudo-doc/docs/claude-md/vendor--design-token-lint): CLAUDE.md at /vendor/design-token-lint/CLAUDE.md
- [Image Enlarge](/pj/zudo-doc/docs/components/image-enlarge): Automatically adds a fullscreen-expand button to images that are wider than their rendered column.
- [create-zudo-doc CLI](/pj/zudo-doc/docs/reference/create-zudo-doc): Complete CLI reference for the create-zudo-doc project scaffolder.
- [Smart Break Utility](/pj/zudo-doc/docs/reference/smart-break): Inject <wbr> hints into long path-like strings so they wrap cleanly in narrow UI.
- [Color Scheme Preview](/pj/zudo-doc/docs/guides/color-scheme-preview): How to browse and preview color schemes using the Design Token Panel's Color tab.
- [Footer](/pj/zudo-doc/docs/guides/footer): How to configure the site footer with link columns, items, and copyright text.
- [Changelog](/pj/zudo-doc/docs/guides/changelog): How to maintain a changelog section in your documentation site.
- [AI Assistant](/pj/zudo-doc/docs/guides/ai-assistant): Built-in chat assistant that answers questions about your documentation.
- [Development Workflow](/pj/zudo-doc/docs/guides/development-workflow): Development commands, build tools, and component development patterns for zudo-doc.
- [Deployment](/pj/zudo-doc/docs/guides/deployment): Deploy zudo-doc sites to Cloudflare Pages with GitHub Actions CI/CD.
- [Search Worker API](/pj/zudo-doc/docs/reference/search-worker): Standalone Cloudflare Worker that provides a server-side search API for zudo-doc, designed for large documentation bases or API consumers.
- [Doc History Server](/pj/zudo-doc/docs/reference/doc-history-server): Standalone package for serving and generating document git history, with dual modes: REST API server for local development and CLI batch generator for CI builds.
- [Layout Pattern Demos](/pj/zudo-doc/docs/guides/layout-demos): Live demonstrations of layout frontmatter options.
- [Claude](/pj/zudo-doc/docs/claude): Claude Code configuration reference.
- [doc-reviewer](/pj/zudo-doc/docs/claude-agents/doc-reviewer): Reviews documentation for accuracy, clarity, and completeness.
- [check-docs](/pj/zudo-doc/docs/claude-skills/check-docs): Check documentation for broken links and formatting issues
- [l-generator-cli-tester](/pj/zudo-doc/docs/claude-skills/l-generator-cli-tester): Test a single create-zudo-doc CLI generation pattern. Scaffolds a project, builds it, starts dev server, and verifies expected features. Use when testing generator output for a specific pattern.
- [l-run-generator-cli-whole-test](/pj/zudo-doc/docs/claude-skills/l-run-generator-cli-whole-test): Run all create-zudo-doc CLI generation tests and fix bugs. Invokes /l-generator-cli-tester for each pattern, collects results, fixes failures, and verifies all patterns pass. Use for comprehensive gen...
- [l-update-generator](/pj/zudo-doc/docs/claude-skills/l-update-generator): Detect and fix drift between the main zudo-doc project and the create-zudo-doc generator CLI. Use when adding/removing features, or to verify the generator stays in sync. Also triggered by "update gen...
- [zudo-doc-design-system](/pj/zudo-doc/docs/claude-skills/zudo-doc-design-system): Project-specific CSS and component rules for zudo-doc. Must be consulted before writing or editing CSS, Tailwind classes, color tokens, or component markup in this project. Covers: component-first str...
- [zudo-doc-navigation-design](/pj/zudo-doc/docs/claude-skills/zudo-doc-navigation-design): Navigation design rules for zudo-doc documentation sites. Consult before creating new pages, restructuring directories, or designing header navigation. Covers: 3-level hierarchy (header → sidebar → ne...
- [zudo-doc-translate](/pj/zudo-doc/docs/claude-skills/zudo-doc-translate): Translate zudo-doc documentation between English and Japanese with project-specific conventions.
- [zudo-doc-version-bump](/pj/zudo-doc/docs/claude-skills/zudo-doc-version-bump): Bump package version, generate changelog docs, commit, tag, and create GitHub release. Use when: (1) User says 'version bump', 'bump version', 'release', or 'zudo-doc-version-bump', (2) User wants to ...
- [zudo-doc-writing-rules](/pj/zudo-doc/docs/claude-skills/zudo-doc-writing-rules): Doc-writing rules for zudo-doc content (mdx files under src/content/docs/ and src/content/docs-ja/). Consult before writing or editing doc content. Covers: no h1 in content, sidebar_position is mandat...