Feature suggestion: allow more flexibility in github release source fact for monorepos

[jlipps]

Contribution guidelines

• I've read the contribution guidelines and wholeheartedly agree

I want to suggest an idea and checked that ...

• ... to my best knowledge, my idea wouldn't break something for other users
• ... the documentation does not mention anything about my idea
• ... there are no open or closed issues that are related to my idea

Description

Currently, source facts are derived from GitHub, including the current release. For monorepos, releases for multiple packages might be published to the same github repo. It would be nice to provide some kind of filtering mechanism to Material so that only releases matching a certain package or string or regex would be included in the source fact.

I encountered this issue while trying to make a new docs system for appium. The release tag which is shown is for a package unrelated to the one I am publishing docs for.

Use Cases

This would benefit monorepo users or those who might want flexibility over which release/tag is shown in the documentation (not simply the first returned by GitHub).

Screenshots / Mockups

[squidfunk]

Thanks for suggesting. I agree that more flexibility would be awesome, but sadly, GitHub's Latest Release endpoint will always return the latest release and doesn't allow for filtering. For a detailed explanation, see #2943 (comment)

Related:

• Support for filtering git tags #2943
• How does Material for MkDocs fetch the latest git tag (to display it in the navbar)? #3439

[jlipps]

OK. Would it be possible to just have an option to not show any repo facts instead, or to show something custom? I guess it's possible to do this by creating an override, but I figure this might be a somewhat common issue.

[squidfunk]

Hiding the tag is easy with a few lines of CSS, as noted in #2481 (comment). I'm not keen on adding another option which we'd have to hand over frommkdocs.yml to base.html to the JavaScript when the same is achievable with a few lines of CSS. Everything else can be customized via theme extension or some additional JavaScript.

[jlipps]

OK, thanks!