search

backstage / mkdocs-monorepo-plugin

✚ Build multiple documentation folders in a single Mkdocs. Designed for large codebases.
https://backstage.github.io/mkdocs-monorepo-plugin/
Apache License 2.0
313 stars 75 forks source link

support edit_uri_template by using at least mkdocs >=1.4.0 #95

Open pjungermann opened 1 year ago

pjungermann commented 1 year ago

Release https://github.com/mkdocs/mkdocs/releases/tag/1.4.0 introduces a new feature edit_uri_template which is a more flexible version of edit_uri.

I've prepared changes to utilize this at https://github.com/backstage/backstage.

Note: mkdocs v1.4.2 supports Python 3.11 https://github.com/mkdocs/mkdocs/releases/tag/1.4.2

Related: https://github.com/backstage/mkdocs-techdocs-core/issues/107

pjungermann commented 1 year ago

related to https://github.com/backstage/backstage/pull/16699

pjungermann commented 6 months ago

since mkdocs-techdocs-core v1.3, it requires

mkdocs>=1.5

This resolves this requirement for a more recent mkdocs version.

However, this packahe itself does not yet require mkdocs >= 1.4.0, and it contains uses of edit_uri e.g. at mkdocs_monorepo_plugin/edit_uri.py.

In order to support edit_uri_template instead, we would require adjustments at this package still.