Incorrect "github repo info" in header

[buhtz]

That field in the header indicate tag "v1.4.3". From a users perspective I would understand that the docu I do see currently is related to that version/tag and build from it.

But that is not true. The docu generating that field is far beyond (~100 commits) that tag.

So, how is this field generated? Can I manipulate it somehow? Can I deactivate it?

Is there a way to indicate for real on which version (branch name, last commit, ...) that docu was build on?

[squidfunk]

I already answered this here.

The information is automatically extracted from the GitHub repository set in repo_url. If you set the URL to the repository of your documentation repository, the version from the latest release of this repository will be used, if any release exists. If no release exists, there will be no version tag.

Also see #2082 (comment).

[buhtz]

Can I somehow (without using CSS hacks) deactivate the whole element?

Sidequestion: Is the content in this element static or are there requests to microsoft github everytime one user opens the documentation?

[kamilkrzyskow]

Can I somehow (without using CSS hacks) deactivate the whole element?

The HTML is included based on the repo_url configuration setting in your mkdocs.yml file:
https://www.mkdocs.org/user-guide/configuration/#repo_url

It's added in both the nav and header:

mkdocs-material/src/templates/partials/nav.html

Lines 55 to 60 in 2412a1b

	<!-- Repository information -->
	{% if config.repo_url %}
	<div class="md-nav__source">
	{% include "partials/source.html" %}
	</div>
	{% endif %}

mkdocs-material/src/templates/partials/header.html

Lines 103 to 109 in 2412a1b

	<!-- Repository information -->
	{% if config.repo_url %}
	<div class="md-header__source">
	{% include "partials/source.html" %}
	</div>
	{% endif %}
	</nav>

So you can disable it by not setting the config.repo_url or setting it to an empty string.

You can also disable it via overrides https://squidfunk.github.io/mkdocs-material/customization/#extending-the-theme
and replace the included source.html partial with an empty version of the file. However, the wrapper will still be included, to exclude the wrapper overriding the nav.html and header.html templates would be required... or better use extra CSS.

Is the content in this element static or are there requests to microsoft github everytime one user opens the documentation?

The fetch to the GitHub API is done once per browser session, so it fetches data once and caches it until the users restarts their browser.

---

EDIT: I see that you're a Codeberg user, if I remember correctly https://github.com/Andre601 had some extra javascript to fetch that statistic data from Codeberg, but I can't find it right now in the discussions 🤔 If you're interested, perhaps ping him?

[squidfunk]

The fetch to the GitHub API is done once per browser session, so it fetches data once and caches it until the users restarts their browser.

Correct. Note that it respects the cookie consent, if configured.

[buhtz]

The fetch to the GitHub API is done once per browser session, so it fetches data once and caches it until the users restarts their browser.

I would treat that as heavy bug. Most users understand MkDocs and its themes as a static site generator.

It might be that I always do not understand the intention of that git-version-stars element in the header. But it doesn't count as a version information. I will check out other solutions to provide a correct version information to my users without exposing them to a US company treating humans as products and disrespecting their privacy.

[squidfunk]

It's not a bug. Most users find this very convenient. But I understand that preferences might be different.

No worries, just remove repo_url and nothing will be queried or displayed at all. Additionally, the fully configurable cookie consent allows you to deactivate it by default, so the user needs to opt-in ☺️ If you wish to keep the repository information, override the source.html partial and remove data-md-component attribute.

That's three levels of possible configuration/customization to fit basically any taste.

[pacharanero]

This issue did catch me out, the new Release was not being updated and I couldn't work out where it was being persisted. It was fixed by deleting the cached browser storage manually in the Developer Console. F5 cache clearing didn't work.