MkDocs¶

Zensical is built by the team behind Material for MkDocs. Compatibility is a core priority.

Zensical can build existing MkDocs projects without requiring changes: It supports mkdocs.yml, preserves the standard project layout, renders Python Markdown content, and recognizes the configuration of supported MkDocs plugins.

Compatibility¶

• Configuration and structure: your existing mkdocs.yml configuration and almost all settings, including nav, theme, extra, plugins, are supported without changes.
• Markdown: Python Markdown, Python Markdown Extensions, and the most popular third-party Markdown extensions can be used without changes.
• Material for MkDocs: Zensical supports the complete settings surface and provides a classic theme variant that preserves the look of Material for MkDocs.
• Customization: additional CSS and JavaScript work without changes when using the classic theme. Template overrides rarely need changes.
• MkDocs plugins: The Zensical team works on providing a growing list of plugin replacements for the most popular MkDocs and Material for MkDocs plugins.
• Commands: Zensical uses the same shape as MkDocs with its build and serve commands, with a small number of differences.

Try Zensical¶

Moving an existing MkDocs project generally requires little or no configuration changes. Use these guides to check compatibility and verify your site before switching to Zensical: