Authors showing as default after mkdocs upgrade

[nitinatgh]

Hi,

I've have recently upgraded the mkdocs-material to 9.5.2 from 8.5.6, and after doing so I am now getting the authors on every page.
Is there a way to disable this from happening, as I expect it to only show when using the {{ git_page_authors }} jinja tag

Author plugin: https://timvink.github.io/mkdocs-git-authors-plugin

mkdocs.yaml

site_name: Docs Site
site_url: https://pages.github.example.com/example/docs-site/
docs_dir: "src"
site_dir: "docs"

repo_name: example/docs-site
repo_url: https://github.example.com/example/docs-site
edit_uri: ""

theme:
  name: material
  palette:
    - scheme: teal
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  custom_dir: overrides
  features:
    - navigation.tabs
  
plugins:
  - search
  - tags:
      tags_file: tags.md
  - git-revision-date-localized:
      timezone: Universal
      type: custom
      custom_format: "%d %B %Y, %H:%M"
      enable_creation_date: true
      fallback_to_build_date: !ENV [GIT_DATE, false]
  - git-authors

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - toc:
      permalink: true
      toc_depth: 3
  - attr_list
  - md_in_html
  - tables

nav:
  - Home:
    - Welcome: index.md
    - Sub Page: sub-page.md
    - Tags Page: tags.md

Thanks

[kamilkrzyskow]

Hello @nitinatgh,
I'm not sure what your issue is with "and after doing so I am now getting the authors on every page", as that's sort of the reason to use the plugin, right? However, you're correct that after Insiders hit the last funding goal there were changes made to the rendering of the partials/source-file.html template, which uses the data provided by git plugins.

mkdocs-material/src/templates/partials/source-file.html

Lines 162 to 165 in ab5ccbe

	<!-- Authors (git-authors plugin) -->
	{% if git_info %}
	{{ render_authors(git_info.get("page_authors")) }}
	{% endif %}

https://github.com/timvink/mkdocs-git-authors-plugin/blob/859a90eeb5fe6f810463b4426e5d28575aee95b0/mkdocs_git_authors_plugin/plugin.py#L222-L225

The template partial expects the git_info object to be present in the context to render the data, so to disable it there are multiple choices:

• Disable the plugin with the enabled option:
  https://timvink.github.io/mkdocs-git-authors-plugin/options.html#enabled
• Disable it only on certain pages with the exclude option (it should support glob wildcards):
  https://timvink.github.io/mkdocs-git-authors-plugin/options.html#exclude
• Override the template file and block the conditional / remove the author rendering altogether:
  https://squidfunk.github.io/mkdocs-material/customization/#extending-the-theme
• Use a hook with a lower priority than the plugin's, and blank out the git_info object after it was set by the plugin:
  https://www.mkdocs.org/user-guide/configuration/#hooks
  https://www.mkdocs.org/dev-guide/plugins/#event-priorities

[nitinatgh]

Thanks @kamilkrzyskow for the detailed reply.

We wanted to control whether to show the author on each page rather than having it shown on all pages, as previous before the change. I understand that we can exclude pages, but that list will be huge for our liking. I will also look at the options above too, but can a feature not be done to control this behaviour as per user needs?

Thanks

Nitin

[kamilkrzyskow]

I'm not sure how the behaviour differs from before, I believe the community version didn't handle git-authors at all, and it was exclusive to Insiders, therefore you used the {{ git_page_authors }} yourself to show the author manually, right? So the best course of action to restore the same behaviour as before would be to use a hook to blank out the git_info object after it is set via the plugin, so it's not available for the template.

Also as mentioned above the exclude option should support glob wildcards, so you should be able to exclude whole directories and path trees, not just single pages.

You can ask for a feature request on more control, but you would have to back it up with a more convenient control flow than the options provided above, like some feature code like content.git.authors that would wrap the git_info conditional, but since you can customize it with a hook, the suggestion might be turned down.

[nitinatgh]

Thanks again for your time on this and explaining it all, will look into the hook option.

Nitin