mkdocs-git-authors-plugin 0.1.1

Mkdocs plugin to display git authors of a page

mkdocs-git-authors-plugin

MkDocs plugin to display git authors of a page. Only considers authors of the current lines in the page ('surviving code' using git blame).

Other MkDocs plugins that use information from git:

• mkdocs-git-committers-plugin for displaying authors' github user profiles
• mkdocs-git-revision-date-localized-plugin for displaying the last revision date

Setup

Install the plugin using pip:

pip install mkdocs-git-authors-plugin

Activate the plugin in mkdocs.yml:

plugins:
  - git-authors

Usage

In supported themes

no supported themes yet

In markdown pages

You can use {{ git_authors_summary }} to insert a summary of the authors of a page. Authors are sorted by their name and have a mailto: link with their email.

An example output:

<span class='git-authors'><a href='mailto:[e-mail]'>Jane Doe</a><a href='mailto:[e-mail]'>John Doe</a></span>

Which renders as:

Jane Doe, John Doe

In theme templates

In theme templates you will have access to the jinja2 variable git_authors, which contains a list of authors dicts, like the following example:

[{
    'name' : 'Jane Doe',
    'email' : '[e-mail]',
    'last_datetime' : datetime.datetime(),
    'lines' : 200,
    'contribution' : '40.0%'
},
{
    'name' : 'John Doe',
    'email' : '[e-mail]',
    'last_datetime' : datetime.datetime(),
    'lines' : 300,
    'contribution' : '60.0%'
}]

An example of how to use in your templates:

{% if git_authors %}
  {%- for author in git_authors -%}
    <a href="{{ author.email }}" title="{{ author.name }}">
      {{ author.name }}
    </a>,
  {%- endfor -%}
{% endif %}

Alternatively, you could use the simple preformatted {{ git_authors_summary }} to insert a summary of the authors.