Configuration¶

Zensical understands your existing mkdocs.yml configuration and automatically adapts it for use within Zensical's own format. You don’t need to change anything – your current settings just work.

When you list MkDocs plugins in your mkdocs.yml, Zensical automatically matches each plugin to an equivalent Zensical module, keeping your documentation working smoothly. As our new module system is completed – and as we reach feature parity with Material for MkDocs – this compatibility will continue to improve in the coming months.

In the future, Zensical modules will introduce their own configuration format. Even then, your old mkdocs.yml will still be supported through a compatibility layer or external optional package. When you’re ready, Zensical will offer tools to help you convert your configuration automatically.

Every step of the way, Zensical provides options that make the transition seamless – so your documentation keeps working, with no interruptions.