Maintainership #3677
Replies: 14 comments 74 replies
This comment was marked as disruptive content.
This comment was marked as disruptive content.
Welcome back Tom! Its good to see things picking up here again and I know the project will be in good hands with you. Who knows, maybe I'll find some time for MkDocs again one day 😄
This sounds like a nice idea. Unfortunately Saturdays are generally not good for me so I wont join but I'll be following from the sides. |
I recommend setting up GitHub Sponsors. I personally find it to be the most convenient way to contribute financially to open source software projects. I was using GitHub Sponsors as a way to support MkDocs prior to the recent change in maintainership and would be happy to continue to do so. |
Didn't notice on first read, but I find this part a bit confusing. Is it speaking about building a team, or leadership? IIUC you are the leadership now @tomchristie ( 🎉 ), so I'm not sure why we make a special case of Material for MkDocs regarding building a team. Don't we want them on the team 🤔? Or did you mean that leadership will be embodied by the whole team? Not sure to understand 😛 |
|
I should have started with that: welcome back Tom! Glad you're stepping up and investing time in MkDocs again to lead its maintenance and growth 🙂 It's good to have someone dedicated to it, especially when they're the original author 😄 Happy to hop on the saturday call to chat 🙂 |
|
Okay, I'll take an open call tomorrow, Sat 27th at 7 AM UTC on https://meet.google.com/fes-iqes-fyr Edit: Confusing myself with timezones. |
|
Thanks @tomchristie and @fralau 🙂 The few things I wrote down:
|
|
Hello, Since Material for Mkdocs entered in maintenance mode, it seems that Mkdocs project needs a fresh start no? |
|
Dear All, First of all, I want to thank you again for your contributions to MkDocs. After these years, it seems that there is a group spirit. 👍 I have briefly looked at Zensical, and I am not sure I get the full picture. @Andre601, why do you deem that MkDocs has become a "roadblock"? You are probably in a better position than me to perceive the technical limitations. My perception is that MkDocs' core is brilliantly built, but the plugin and extensions ecosystem has grown in various directions, and might need some organizing principles (particularly to make the plugins compatible with each other). |
|
Dear Friends, I looked at the statistics of MkDocs, and I found there are 86'000 repositories, small and big, that rely on MkDocs. This project has 21.3K stars. That indicates that there are tens of thousands of websites right now, that depend on MkDocs for their production. It is a fact that MkDocs is a trusted product that changed life for a lot of documentation writers. A lot of them, like me, have a debt of gratitude to its author and maintainers. There is profound intelligence in the way it was designed, and thoughtfulness about how to extend it with plugins; it evolved over the years with many contributions. Certainly, MkDocs's author and maintainers would make it differently today. However, it has the merit to exist and to work. This discussion itself is proof that MkDocs matters. The scope of this discussion is thus our shared responsibility toward those many people (documenters, developers) who have been helped, and are being helped daily, by MkDocs. For the current situation, indeed the code frequency (additions or deletions per week) indicates that this project might be in a dangerous position. However, solving it, may not necessarily mean taking draconian measures. On the contrary, it might become solvable if we consider that everyone here has good intentions and has demonstrated competence in some key areas; and by pointing the finger at facts, rather than individuals. An action in that direction would be to pull our heads together on the questions raised by #4010, which (in my understanding) is essentially a question of PRs and commits. What if we decomposed that problem in its constituent parts? |
|
I believe that in a discussion where there are disagreements, we should at least find a few basic facts we can all agree with. The first is that we all love MkDocs and wish it to continue and improve. Another key fact, is that we all wish to respect and follow the rules that govern open source software, and the management of public repos. MkDocs is published under a BSD-2 (simplified) license, which is permissive. This gives rights and duties to each party:
So that leaves us with only two acceptable solutions:
Solution 1 requires acknowledgement of and respect for Tom's rights. With solution 2, each of us would decide which project they want to stay with. A fork could be done in an amicable way, by stating and respectfully acknowledging each other's divergences. That would be much better, so that users would then know why they are choosing one project or the other. I would welcome solution 1 and encourage it; but I wouldn't oppose 2 if that was required to restore the peace. |
|
Happy New Year 2026! Following up on the conversation, do we now wish to explore the fork solution? |
|
For the users arriving here without much context about what to do next, your best bet is to move to Zensical. It was built by the creators of Material for MkDocs and they provide an easy migration path. An update was posted earlier today that touches on plugin parity. Although some plugins are not yet available, it's worth mentioning that MkDocs plugins are a distinct concept separate from Markdown extensions. All of the extensions you are familiar with are supported and you can likely migrate today. |
|
We have been heads down migrating from httpx to aiohttp due to the sudden and unexpected death of the project (check encode/httpx#3784 for details) Then I ended up on this page, coming across familiar faces... Thank you @ofek for your note on Zensical, and preventing yet another supply chain disaster. |
Uh oh!
There was an error while loading. Please reload this page.
Hey team,
I'm going to be stepping up as lead maintainer for MkDocs again. For those of you who don't know me, I'm the project's original author and have worked on a stack of open source projects over the last decade.
There's a fantastic core here, but we're really not capitalising on that at the moment.
Priorities that I can see for the project are...
There's a couple of challenges here...
One of the pressing issues is that without a proper funding approach we're not going to be able to provide dedicated time towards improving MkDocs. Martin and his team have been doing a fantastic job of that over at Material for MkDocs, and there's plenty of scope for this project to also be drawing in funding and supporting its future development.
I can also see some challenges around the existing plugin architecture. Having themes be tied into Python packaging is going to hold back the project from having a wide adoption outside of the Python bubble. It also makes it difficult to provide safe theming options, since we're guiding users towards installing and running Python code where in many cases there's HTML templating & styling alternatives that would be sufficient. Navigating how we improve this is decidedly non-obvious.
As regards team management I don't have any significant concerns, although we will need invested parties stepping up. I do think it's important for the ecosystem that MkDocs has a strong and independant leadership distinct from Material for MkDocs, while still drawing from their expertise & experiance. We've got plenty of smart capable people here, and I'm sure we'll be able to step up to the mark, together.
I'll take an open video call this Saturday, for anyone who'd like to discuss any of the above as well as an opportunity for us to have some face-to-face time.
Tagging y'all for now...
@Andre601 @athackst @bczsalba @blueswen @byrnereese @chrieke @daizutabi @d0ugal @EddyLuten @facelessuser @fralau @greenape @Guts @JakubAndrysek @koaning @LukeCarrier @lyz-code @mondeja @ofek @ojacques @pawamoy @six-two @smarie @squidfunk @timmeinerzhagen @timvink @unverbuggt @waylan @wilhelmer
(And yes, we should probably sort out a @mkdocs/community team.)
All reactions