Choose the guide that matches your background:
From Sphinx/RST
You know RST directives,.. note::, andconf.py. Bengal's MyST syntax will feel familiar.
From Hugo
You use Hugo shortcodes like{{</* highlight */>}}and Go templates. Bengal directives work similarly.
From Docusaurus/MDX
You write MDX with React components like<Tabs>. Bengal offers the same features without JSX.
Quick Comparison
| Feature | Sphinx/RST | Hugo | Docusaurus | Bengal |
|---|---|---|---|---|
| Callouts | .. note:: |
{{</* notice */>}} |
:::note |
:::{note} |
| Tabs | Extension | {{</* tabs */>}} |
<Tabs> |
:::{tab-set} |
| Code inclusion | .. literalinclude:: |
readFile |
Import | :::{literalinclude} |
| Config format | conf.py |
config.toml |
docusaurus.config.js |
bengal.toml |
| Template engine | Jinja2 | Go templates | React | Jinja2 |
Common Ground
All guides assume you're comfortable with:
- Markdown basics
- YAML frontmatter
- Command-line tools
- File-based content organization
What Makes Bengal Different
Key Insight
Bengal combines the structured directive syntax of Sphinx, the file-based simplicity of Hugo, and the rich components of Docusaurus—all in pure Markdown without compilation steps or framework lock-in.
Choose your guide above to see specific feature mappings and examples.
In This Section
From Sphinx/RST
Onboarding guide for Sphinx and reStructuredText users migrating to Bengal
From Hugo
Onboarding guide for Hugo users migrating to Bengal
From Docusaurus/MDX
Onboarding guide for Docusaurus and MDX users migrating to Bengal
Related Pages
Analyze and Improve Site Connectivity
Learn to discover, interpret, and act on site structure insights using Bengal's graph analysis tools
Migrate from Hugo
Migrate your site from Hugo, Jekyll, Gatsby, or other static site generators to Bengal