Documentation

Guides for building documentation sites, blogs, knowledge bases, and product sites with Bengal

8 pages in this section

Start Here

New to Bengal? Start here to build documentation sites, blogs, knowledge bases, and product sites with Python. Bengal covers authoring, search, SEO/discovery, theming, deployment, and performance in one toolchain.

Get Started
Install Bengal and create your first site
Tutorials
Guided learning journeys to master Bengal

Write & Organize

Author content in Markdown, structure your site, and validate quality.

Author
Markdown, MyST directives, code blocks, and callouts
Organize
Pages, sections, bundles, and frontmatter
Reuse
Snippets, data files, and DRY patterns
Validate
Health checks, linting, and auto-fixes
Version
Maintain multiple doc versions side-by-side
Analyze
Find orphan pages and optimize internal linking

Customize

Control appearance with themes, templates, and CSS. Add custom directives, content sources, and build hooks.

Theming
Templates, assets, and visual customization
Extending Bengal
Custom directives, content sources, collections, and build hooks

Build & Ship

Configure builds, optimize performance, improve SEO/discovery, and deploy to production.

Configure
Site settings, environments, and build options
SEO & Discovery
Metadata, sitemap, feeds, canonical URLs, social cards, and search
Performance
Incremental builds, caching, and parallel processing
Deploy
GitHub Pages, Netlify, Vercel, and CI/CD
Troubleshoot
Common issues and how to resolve them

Look It Up

Technical specifications, directive syntax, architecture details, and project background.

Reference
Technical specifications, directives, and architecture
About
Concepts, benchmarks, and philosophy

In This Section

About A pure-Python documentation generator built on free-threading — every layer scales with your cores 10 pages
Get Started Install Bengal and create your first site 6 pages
Content Author, organize, and validate your documentation 2 pages
Tutorials Step-by-step guides for building with Bengal 2 pages
Theming Templates, assets, and visual customization 2 pages
Building Build configuration, SEO/discovery, output formats, and deployment 6 pages
Extending Bengal Create custom directives, content sources, collections, and build hooks 9 pages
Reference Technical specifications, directives, and architecture 7 pages
Related Pages
For Python Teams Why Bengal is the natural documentation choice for teams already working in Python Related
Autodoc System AST-based Python documentation generator Related
Content Type Strategies Strategy pattern for content type-specific behavior (sorting, templates, pagination) Related