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
323 stars 74 forks source link

Will you maintain this plugin even with the new Mkdocs Insiders Projects Plugin? #106

Open jorgegomezcq opened 1 year ago

jorgegomezcq commented 1 year ago

Hi,

Will this project continue to be developed in light of the new built-in projects plugin that is part of MkDocs Insiders?

https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-projects-plugin

pjungermann commented 1 year ago

The projects plugin is "sponsors only" at this time. Some of the edit_uri logic might still be needed. 🤔

squidfunk commented 1 year ago

Author of Material for MkDocs here. We're really psyched giving the projects plugin into more hands and adding all functionality that is necessary to build documentation projects from multiple sources. I'm not sure what the mkdocs-monorepo plugin does with edit URIs, but the projects plugin allows to define a custom configuration transform function via the projects_config_transform setting that allows to customize the configuration of projects when built together.

We're using it on our examples reposistory to customize edit_uri per project.

bih commented 10 months ago

We're aware of the projects plugin created by Material for Mkdocs, and it serves slightly different needs. They seem to have their plugin only available to paid customers (which is different from us) and their plugin seems tightly coupled with the use of Mkdocs Material. If those two things no longer become true, we'd happily sunset this plugin :)

squidfunk commented 10 months ago

The projects plugin works with all MkDocs projects and themes, so you're not bound to Material for MkDocs ☺️ Just use:

plugins:
  - material/projects

You can combine any MkDocs projects with any themes and mix and match.

Other than that, we have our plugin available to sponsors that support our ongoing efforts in keeping Material for MkDocs and its plugins in good shape and up-to-date. We're not considering them customers, but users who actually care about Open Source and the people behind it, supporting us in trying to make the world of software a better place.

bih commented 10 months ago

@squidfunk Ah thanks for the clarification. Are there any intentions to make this available to all users at a later point?

squidfunk commented 10 months ago

Of course, as promised by the sponsorware strategy. It will be released into the community edition once the associated funding goal is hit. We've and will always keep our promises.

bih commented 10 months ago

Oh fantastic! In that case, we're very open to the idea of sunsetting this library once the plugin is available to all users.