Documentation Tools Cheat Sheet
|
This content was generated with the assistance of AI and should be verified against the official documentation of each tool before being relied on in production. This section’s bibliography lists the reference material consulted while preparing these pages. |
A single-page, colour-coded summary of the four documentation tools of this section — a "which tool" chooser with a mini feature matrix, one column per tool (install, create, serve and build, minimal configuration, project layout, link syntax, admonitions, diagrams and math, versioning, search, theming entry point and the GitHub Pages recipe), a strip for the Antora UI bundle and a strip of what changed recently. It reflects Antora 3.2.1, Docusaurus 3.10.2, Zensical 0.0.72 (alpha) and DocFX 2.81.0, checked on 2026-10-26, and is available as a downloadable PDF.
For the full explanation, every option, and additional examples, see the dedicated pages:
Antora — Antora, Install and Quickstart, Playbook, Content Sources, Component Version Descriptor, Versioning and Prerelease, Modules and Families, Resource IDs and Xrefs, Navigation, Partials, Examples and Attachments, AsciiDoc Attributes and Extensions, Antora Extensions, Site Search, Collector, Atlas and Assembler, CLI, Docker, Cache and Private Repositories, Publishing, Case Study: This Site, Troubleshooting, UI Bundle, Building a Custom UI, Templates and UI Model, Helpers, Stylesheets, Fonts and Static Files, Supplemental UI, Search and Analytics Integration, and Publishing a UI Bundle.
Docusaurus — Docusaurus, Installation and Project Structure, Configuration, Docs and Front Matter, Sidebars, Blog and Pages, MDX and React Components, Markdown Features, Diagrams and Math, Versioning, Internationalization, Search, Styling, Theming and Swizzling, Plugins and Presets, SEO and Static Assets, Deployment, CLI and TypeScript, Docusaurus Faster and v4 Readiness, and OpenAPI Docs.
Zensical — Zensical, Installation and CLI, Configuration, Navigation, Markdown Authoring, Diagrams, Math and Icons, Theming and Customization, Search, Blog, Tags and Plugins, API Docs with mkdocstrings, Versioning and i18n, Validation and Publishing, Migrating from Material for MkDocs, and Roadmap and Upgrade Policy.
DocFX — DocFX, Basic Concepts and Pipeline, docfx.json, DotNet API Docs, REST API Docs, Markdown, Table of Contents, Links and Cross References, Templates and Customization, PDF Output, Additional Languages, CLI, and Deployment.
Comparison — Comparison.
Cheat Sheet (PDF) — Cheat Sheet (PDF).
Choosing and comparing — Documentation Tools and Comparison.