Customising and packaging mkdocs-material

[SoumayaMauthoorMOJ]

I would like to customise mkdocs-material to fit with our organisation design standards and package it so that it can be applied to other repos as a theme. mkdocs has generic material about packaging themes : https://www.mkdocs.org/dev-guide/themes/#packaging-themes. Do you have material about packaging themes based on mkdocs-material?

[squidfunk]

It's probably a better idea to ask the maintainers of MkDocs, since your question generalizes to packaging customizations for an existing MkDocs theme. I think it should be possible to package an extended theme, but I've never done it.

[SoumayaMauthoorMOJ]

Thanks for letting me know will ask!

[sumau]

Just in case anyone else interested, you can package customizations of existing MKdocs theme the same way that you can package themes. You just need to extend the existing theme in the mkdocs_theme.yml file:

extends: material

Note that the instructions for packaging themes is a bit out of date. My project uses pyproject.toml and setup.cfg following the approach in this project, but you could use other build backends