Add `branch` as information available through git

fralau / mkdocs-macros-plugin

Create richer and more beautiful pages in MkDocs, by using variables and calls to macros in the markdown code.

https://mkdocs-macros-plugin.readthedocs.io

Other

318 stars 50 forks source link

Add `branch` as information available through git #211

Closed jbadwaik closed 5 months ago

jbadwaik commented 6 months ago

I am using mkdocs-macro plugin to configure the mike plugin for mkdocs in order to display multi-version documentation. In that context, I would like to mark certain branches as dev and others as experimental. And for that, I need the branch names in git as well.

I've added the branch property in get_git_info().

fralau commented 6 months ago

Thank you for your contribution!

According to the contributing guidelines, could I ask you to open an issue referring to this PR, explaining the use case and the issue you want to solve?

Then please link this PR to the issue, and vice-versa.