build: Restrict mkdocs-material to 9.4.x versions #255
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
https://github.com/squidfunk/mkdocs-material/blob/9.5.0/src/templates/partials/source-file.html#L57
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:
It might be a privacy concern, opening documentation contributors to spam from someone who scrapes the docs site for email addresses.
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