Merged features tied to 'Goat's Horn' funding goal #6447
Conversation
In version 9.5.0, the mkdocs-material project introduced a new way of interacting with the git-authors plugin: rather than relying on that plugin to render information about page authors, mkdocs-material now does that rendering by itself. In doing so, it unfortunately provides no facility to render just the author name, without their email address (a facility that *is* available with the git-authors plugin). This is problematic for two reasons: 1. It might be a privacy concern, opening documentation contributors to spam from someone who scrapes the docs site for email addresses. 2. It breaks link checking, since some of the email addresses thus rendered are purposefully bogus (specifically, `users.noreply.github.com` is a non-existent email domain since it lacks an MX record in the DNS). Until this is fixed (or we find a suitable workaround), restrict mkdocs-material to 9.4.x versions. References: squidfunk/mkdocs-material#6447 timvink/mkdocs-git-authors-plugin#66
|
@squidfunk Just a small note, you may want to choose to make the inclusion of authors' email addresses configurable, as it previously was when using the Please see timvink/mkdocs-git-authors-plugin#66 (review) for a related discussion on author privacy, and also citynetwork/docs#255 for considerations on external link checking. The current situation is rather awkward because a user can include the following snippet in their configuration: plugins:
- git-authors:
enabled: true
show_email_address: false... and then assume that email addresses would be suppressed, but they are not. |
|
Thanks for noting. I wasn't aware of this option, maybe it was added after we did the initial integration. Would you like to propose a PR for this? I guess it's only a simple switch in the partial that renders the authors. |
|
I can have a go at that; would I be able to use the same logic as in the patch I submitted to the |
|
Draft PR is in #6494; let me know if that's the right way to go. |
This PR contains all features that are tied to the Goat's Horn funding goal, which we just reached:
❤️ ❤️ ❤️
Thanks again to all of our awesome sponsors for making our work on this project sustainable! Without you, all of those features would not exist. We hope for your continued support, as it allows us to ship more useful and unique features, like for example the projects plugin, which allows to build multiple MkDocs projects together.
If you're a heavy user of Material for MkDocs, consider sponsoring @squidfunk, so we can make this project even more useful in the future and keep it in good shape! In 2023, I've started to build a small team around me and must rely on the financial support by our sponsors so we can keep up with the insane growth of the project and provide support to each of you!