timvink / mkdocs-git-authors-plugin

MkDocs plugin to display git authors of a page.
https://timvink.github.io/mkdocs-git-authors-plugin
MIT License
68 stars 17 forks source link

Make Github username available like {email} and {name} #84

Closed anitagirme closed 1 month ago

anitagirme commented 1 month ago

Description

Make Github username available like {email} and {name} so that it can be used in href options for creating link to user's profile.

Definition of Done

timvink commented 1 month ago

This is impossible as that information is not recorded by git.

You can however retrieve the GitHub username (and additional information) using the GitHub api. There's another plugin to do that: https://github.com/ojacques/mkdocs-git-committers-plugin-2

See also these docs for more background info https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/?h=git