Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: Restrict mkdocs-material to 9.4.x versions #255

Merged
merged 1 commit into from
Dec 12, 2023

Conversation

fghaas
Copy link
Contributor

@fghaas fghaas commented Dec 11, 2023

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:

  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

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
@fghaas fghaas merged commit 3577207 into citynetwork:main Dec 12, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants