Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jorgegomezcq opened this issue Aug 4, 2023 · 7 comments
Labels
question Further information is requested

Comments

@jorgegomezcq
Copy link

jorgegomezcq commented Aug 4, 2023

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
Copy link

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

@squidfunk
Copy link

squidfunk commented Oct 2, 2023

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
Copy link
Collaborator

bih commented Jan 4, 2024

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 :)

@bih bih added the question Further information is requested label Jan 4, 2024
@bih bih changed the title Built-in projects Mkdocs Insiders Monorepo Plugin Will you maintain this plugin even with the new Mkdocs Insiders Projects Plugin? Jan 4, 2024
@squidfunk
Copy link

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
Copy link
Collaborator

bih commented Jan 5, 2024

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

@squidfunk
Copy link

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
Copy link
Collaborator

bih commented Jan 7, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants