Support for other remote Git Repositories?

[Andre601]

Material for MkDocs currently supports GitHub for displaying stats such as stars, forks and latest release on the site... My question is, if this can be configured and/or extended to support other remote Git hosts such as GitLab, BitBucket, Codeberg, etc.

Preferrably, support for any Gitea/Forgejo instance through matching configuration would be wonderful.

If for whatever reason it isn't doable on your end directly, is there a way to achieve this using theme extension alone? Or would a plugin be necessary to achieve this?

Thanks in advance for a reply.

[squidfunk]

Yes, this can be extended! We're already offering support for GitHub and GitLab, which are the most popular coding platforms. We're currently not planning to add support for other, lesser known platforms, because there are just not as many users that would justify the increased maintenance burden, but you can certainly fork the theme and add it on your fork!

GitHub is here:

mkdocs-material/src/assets/javascripts/components/source/facts/github/index.ts

Lines 60 to 103 in c2e5558

	export function fetchSourceFactsFromGitHub(
	user: string, repo?: string
	): Observable<SourceFacts> {
	if (typeof repo !== "undefined") {
	const url = `https://api.github.com/repos/${user}/${repo}`
	return zip(
	/* Fetch version */
	requestJSON<Release>(`${url}/releases/latest`)
	.pipe(
	catchError(() => EMPTY), // @todo refactor instant loading
	map(release => ({
	version: release.tag_name
	})),
	defaultIfEmpty({})
	),
	/* Fetch stars and forks */
	requestJSON<Repo>(url)
	.pipe(
	catchError(() => EMPTY), // @todo refactor instant loading
	map(info => ({
	stars: info.stargazers_count,
	forks: info.forks_count
	})),
	defaultIfEmpty({})
	)
	)
	.pipe(
	map(([release, info]) => ({ ...release, ...info }))
	)
	/* User or organization */
	} else {
	const url = `https://api.github.com/users/${user}`
	return requestJSON<User>(url)
	.pipe(
	map(info => ({
	repositories: info.public_repos
	})),
	defaultIfEmpty({})
	)
	}
	}

And integration is here:

mkdocs-material/src/assets/javascripts/components/source/facts/_/index.ts

Lines 68 to 88 in c2e5558

	export function fetchSourceFacts(
	url: string
	): Observable<SourceFacts> {
	/* Try to match GitHub repository */
	let match = url.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i)
	if (match) {
	const [, user, repo] = match
	return fetchSourceFactsFromGitHub(user, repo)
	}
	/* Try to match GitLab repository */
	match = url.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i)
	if (match) {
	const [, base, slug] = match
	return fetchSourceFactsFromGitLab(base, slug)
	}
	/* Fallback */
	return EMPTY
	}

[Andre601]

What about a general support for Gitea/Forgejo-based APIs?
They are pretty much the same for the stats you get, so it could be one single system. Only requirement would then be for the user to specifically tell MkDocs Material that the repo uses a gitea-based software and the Domain used...

Tho, can understand that this may be a lot of extra work.

[Andre601]

Would you be willing to look at a PR if I implement support?

Tho, I consider to try and implement a general support for any forgejo/gitea instance, so that people can display stats from a repository of their own instance.
The only question here would be what a optimal regex pattern - if any - would be to use here, as with forgejo/gitea any domain pattern would be a possible solution... Only the API path may be consistent...