GeoJulien

馃殌 I've just released the version 1.17.0 of the RSS plugin for MkDocs: https://github.com/Guts/mkdocs-rss-plugin/discussions/342

馃摪 It improves the integration with the blog plugin of the awesome Material for Mkdocs framework, developed by @squidfunk and co.

馃搼 More details in documentation: https://guts.github.io/mkdocs-rss-plugin/integrations/#blog-plugin-from-material-theme

#MkdocsRssPlugin #MaterialForMkdocs #RSS #json_feed #MkDocs

1.17.0 路 Guts mkdocs-rss-plugin 路 Discussion #342

What's Changed Features and enhancements 馃帀 refacto(material_integrations): use POO to manage integrations with Material theme framework by @Guts in #335 update(chore): use typed dataclasses instead...

GitHub
Dec 2, 2024 at 9:22pmWeb
Show threadMartin DonathDec 3, 2024
@geojulien awesome, thanks for investing the time into improving the integration! We're currently looking into making plugin interop much, much simpler, as it's too fragile right now.
Show threadGeoJulienDec 3, 2024

@squidfunk should I start learning Rust 馃槒?

Why do you find this fragile? In my experience, MkDocs and Material do a pretty good job and it's pretty clear on how to integrate with.

I'm more concerned about the adherence and the dependency between projects, given that the development and therefore the evolution capacities are not the same at all. I also have my doubts about regressions because I don't see much testing of plugins.

Show threadMartin DonathDec 3, 2024
@geojulien well, there's currently no good way to synchronize plugins. I've tried to do this with, say, the optimize and privacy plugin, and it works to some degree, but the relationships are all implicit and rely on event priorities that any plugin can set. Also, it's unclear what part of a plugin might be subject to change in the future, i.e., what is API and what is implementation. There are best practices, but no layer that enforces this.
Show threadMartin DonathDec 3, 2024
@geojulien I started learning Python only when writing plugins, so they historically have no tests. It started out as a theme but grew past that, and now I regret not having proper tests. However, our current efforts will all be properly tested and integration will be much easier. We feel that it is time to finally clean up a lot of the mess that we made along the way, as Material for MkDocs has proven to be a valuable tool for so many people.
Show threadMartin DonathDec 3, 2024
@geojulien so should you learn Rust? I'd say only if you have a problem that you want to solve with it. We have a problem that we must solve in a lower level language, so I had the motivation to endure the valley of tears. The first 1-2 months were very hard, but now it is smooth sailing.
Show threadGeoJulienDec 3, 2024

@squidfunk I wasn't necessarily talking about the Material theme plugins. If they're not well covered by tests, the size of the installation base, make sure that issues raise up and you've proved your responsiveness in fixing them.

For my part, to try and anticipate upstream developments as much as possible, I've opted for modularity and systematic opt-out option (https://github.com/Guts/mkdocs-rss-plugin/tree/main/mkdocs_rss_plugin/integrations).

But it's a fairly recent choice after all and I've also had a lot of historic mess to clean up :).

mkdocs-rss-plugin/mkdocs_rss_plugin/integrations at main 路 Guts/mkdocs-rss-plugin

MkDocs plugin to generate a RSS feeds for created and updated pages, using git log and YAML frontmatter (page.meta). - Guts/mkdocs-rss-plugin

GitHub