Add a link to best-of-mkdocs in the readme #2824
Conversation
|
I like the idea of mkdocs providing an "official" curated list, while the wiki's is more "add your own" style But curation means decision, what's the process to enter the list? How does it differ from the wiki "free for all" strategy? |
|
Until know, I've added almost everything we had in the wiki (I might have lost some in the grepping process), and searched for more on GitHub and PyPI. I didn't follow any process other than: does the project have a description and an easy way to install/use it. Since the best-of algorithm doesn't filter out anything but rather puts "low reputation" projects into collapsed lists (less visibility for those, less noise generally) I think it's safe to continue adding things without asking questions :) |
|
Sorry for the total silence from me. I have finally gotten around to this. |
|
That's great, thank you @oprypin! |
Following the advice of @squidfunk, I'm opening this PR to get feedback from MkDocs maintainers and open a discussion馃檪
This PR adds a link to the best-of-mkdocs list I've just created to the README.
Providing such curated data / galleries of examples in MkDocs own docs has been discussed previously in #2700.
I wouldn't mind transferring the best-of list to the MkDocs org and keep maintaining it, if that's something you'd like (it's pretty low maintenance as the only file to update is the YAML data, the rest is automatically rendered through a GitHub action).
One of the benefits of the best-of list is that it logs useful information during the rendering process. For example, I was able to fix several plugins URLs as they had been renamed or transferred to other GitHub accounts.
Another small benefit is that with a restricted access (PRs, contrary to the wiki), we won't have to remove spam contents added from time to time by users, or revert accidental/malicious deletions. And it's still very easy for the community to contribute.