# MkDocs

Zensical is built by the team behind [Material for MkDocs](<https://squidfunk.github.io/mkdocs-material/>). 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.

> [!NOTE]
>
> **Planning your organization’s transition**
>
> Zensical Spark gives your organization a closer working relationship with our team, with membership options for migration planning, ongoing support, and collaboration. [Learn more about Zensical Spark.](<https://zensical.org/spark/>)

## Compatibility

- [x] **Configuration and structure:** your existing `mkdocs.yml` configuration and [almost all settings](<https://zensical.org/docs/compatibility/mkdocs/migration/#unsupported-settings>), including `nav`, `theme`, `extra`, `plugins`, are supported without changes.
- [x] **Markdown:** [Python Markdown](<https://zensical.org/docs/compatibility/markdown/python-markdown/index.md>), [Python Markdown Extensions](<https://zensical.org/docs/compatibility/markdown/python-markdown-extensions/index.md>), and the most popular third-party Markdown extensions can be used without changes.
- [x] **Material for MkDocs:** Zensical supports the complete settings surface and provides a [`classic` theme](<https://zensical.org/docs/compatibility/mkdocs/migration/#theme-variant>) variant that preserves the look of Material for MkDocs.
- [x] **Customization:** [additional CSS](<https://zensical.org/docs/customization/#additional-css>) and [JavaScript](<https://zensical.org/docs/customization/#additional-javascript>) work without changes when using the `classic` theme. Template overrides [rarely need changes](<https://zensical.org/docs/compatibility/mkdocs/migration/#templates-and-overrides>).
- [x] **MkDocs plugins:** The Zensical team works on providing a growing list of [plugin replacements](<https://zensical.org/docs/compatibility/mkdocs/plugins/index.md>) for the most popular MkDocs and Material for MkDocs plugins.
- [x] **Commands:** Zensical uses the same shape as MkDocs with its [`build`](<https://zensical.org/docs/usage/build/index.md>) and [`serve`](<https://zensical.org/docs/usage/preview/index.md>) 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:

- [Migrate from MkDocs](<https://zensical.org/docs/compatibility/mkdocs/migration/index.md>)

  ---

  Review the configuration, command-line, theme, and template differences that matter when moving an existing project.
- [MkDocs plugin support](<https://zensical.org/docs/compatibility/mkdocs/plugins/index.md>)

  ---

  Find supported plugin replacements, installation requirements, and Zensical-specific caveats.
- [Python Markdown](<https://zensical.org/docs/compatibility/markdown/python-markdown/index.md>)

  ---

  Consult the complete Python Markdown reference to learn about the supported syntax, extensions, and settings.
- [Build your site](<https://zensical.org/docs/usage/build/index.md>)

  ---

  Build and review a prototype or copy of your site before switching to Zensical in production.