Skip to content

Command line interface

Apart from the fact that zensical replaces mkdocs on the command line, there are some slight differences. Make sure to review these and update your build and CI scripts accordingly. Refer to the command line interface page in our documentation for further details.

  • build and serve commands:

    • The --theme (-t) option is not supported, and we currently only offer a single theme, though this will change once we start working on the module system.

    • The --use-directory-urls and --no-directory-urls options are not supported. Set use_directory_urls in your configuration file instead, exactly as in MkDocs.

    • --site-dir is not supported. Set site_dir in your configuration file instead.

    • --strict mode is currently ignored, but we're working on adding proper validation of configuration options and links between pages, gracefully failing the build.

  • serve command: the --dirty command-line option is unnecessary, and thus ignored, since Zensical employs caching where possible to be fast by default.

  • gh-deploy command: we plan to support many more deployment methods, so we're not implementing MkDocs' gh-deploy command. See our publishing guide for alternatives.

  • get-deps command: this command is not supported. Instead, we recommend declaring explicit dependencies in the pyproject.toml file, as per standard Python development practices.