Introduction
Installation
Quick Start
Configuration
Project Structure
Features
Mermaid Diagrams
Collapsible Chapters
Search
Multi-language
Glossary
Import Files
Front Matter
Templates
AsciiDoc
Math (KaTeX)
SVG Processing
OpenAPI / Swagger
Self-Update
Migration from HonKit
FAQ
A-
A+
Features
guidebook comes with many built-in features:
Mermaid Diagrams
- Create diagrams with code
Collapsible Chapters
- Expandable sidebar navigation
Search
- Full-text search
Multi-language
- Write books in multiple languages
Glossary
- Auto-linked term definitions with tooltips
Import Files
- Include content from other files
Front Matter
- YAML metadata for pages
Templates
- Nunjucks/Jinja2 conditionals, loops, and filters
AsciiDoc
- Use
.adoc
files alongside Markdown
Math (KaTeX)
- Render mathematical formulas
SVG Processing
- Externalize or inline SVG files
OpenAPI / Swagger
- Generate Swagger UI from specs
Self-Update
- Update guidebook from the CLI