/mkdocs-git-committers-plugin-2

MkDocs plugin for displaying a list of GitHub (.com or Enterprise) contributors on each page. Encourages contributions to the documentation!

Primary LanguagePythonMIT LicenseMIT

mkdocs-git-committers-plugin-2

This is a plugin which is a fork from the original mkdocs-git-committers-plugin by @byrnereese.

MkDocs plugin for displaying a list of committers associated with a file in mkdocs.

I had to create this fork so that it could be uploaded and distributed through PyPi. The package has been renamed to mkdocs-git-committers-plugin-2.

This "v2" differs from the original by:

  • Use local git repo information to go through commits. In my test repos, I went from 200 API calls down to 10 (for a repository with 10 unique authors)
  • Fetch GitHub info only for authors
  • Fetch GitHub info for authors not fetched before
  • last_commit_date is now populated with local git info
  • avatar is populated with gravatar info if there is no git token
  • Save all author information in a cache file to speed up following builds

All of the above massively improve performances and reduce the chances to hit GitHub API rate limits.

Note: the plugin configuration in mkdocs.yml still uses the original git-committers sections.

Setup

Install the plugin using pip:

pip install mkdocs-git-committers-plugin-2

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - git-committers

Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set, but now you have to enable it explicitly.

More information about plugins in the MkDocs documentation.

Config

  • enterprise_hostname - The enterprise hostname of your github account (Github Enterprise customers only).
  • repository - The name of the repository, e.g. 'ojacques/mkdocs-git-committers-plugin-2'
  • branch - The name of the branch to pull commits from, e.g. 'master' (default)
  • token - A github Personal Access Token to avoid github rate limits. The token does not need any scope: uncheck everything when creating the GitHub Token at https://github.com/settings/tokens/new
  • cache_dir - The path of where to store the authors cache file, used to speed up documentation builds. Defaults to .cache/plugin/git-committers/. The cache file will be named authors.json in that directory
  • enabled - Disables plugin if set to False for e.g. local builds (default: True)

Tip: You can specify the GitHub token via an environment variable in the following way:

plugins:
  - git-committers:
      repository: johndoe/my-docs
      branch: master
      token: !ENV ["MKDOCS_GIT_COMMITTERS_APIKEY"]

If the token is not set in mkdocs.yml it will be read from the MKDOCS_GIT_COMMITTERS_APIKEY environment variable.

If no token is present, the plugin will determine information with local git repository information only.

Usage

Display Last Commit

In addition to displaying a list of committers for a file, you can also access the last commit date for a page if you want to display the date the file was last updated.

Template Code

<ul class="metadata page-metadata" data-bi-name="page info" lang="en-us" dir="ltr">
  <li class="last-updated-holder displayDate loading">
    <span class="last-updated-text">Last updated:</span>
    <time role="presentation" datetime="2018-10-25T00:00:00.000Z" data-article-date-source="ms.date">{% if last_commit_date %}{{ last_commit_date }}{% endif %}</time>
  </li>
</ul>

Display List of Committers

Avatar

If the GitHub token is configured, a GitHub API request is made to retrieve the avatar from GitHub. If not, the avatar attribute is populated with gravatar identicon with an MD5 hash on the email address. If the author has configured gravatar for this email address, the avatar will show properly, otherwise a random but fixed gravatar identicon is generated.

Template Code

{% block footer %}
<ul class="metadata page-metadata" data-bi-name="page info" lang="en-us" dir="ltr">
  <li class="contributors-holder">
    <span class="contributors-text">Contributors</span>
    <ul class="contributors" data-bi-name="contributors">
      {%- for user in committers -%}
      <li><a href="{{ user.url }}" title="{{ user.name }}" data-bi-name="contributorprofile" target="_blank"><img src="{{ user.avatar }}" alt="{{ user.name }}"></a></li>
      {%- endfor -%}
    </ul>
  </li>
</ul>
{% endblock %}

CSS

.metadata{
    list-style:none;
    padding:0;
    margin:0;
    margin-bottom: 15px;
    color: #999;
    font-size:0.85em;
}
.metadata.page-metadata .contributors-text{
    margin-right:5px
}
body[dir=rtl] .metadata.page-metadata .contributors-text{
    margin-right:0;
    margin-left:5px
}
.page-metadata .contributors{
    display:inline-block;
    list-style:none;
    margin:0!important;
    padding:0!important
}
.page-metadata .contributors li{
    display:inline-block;
    vertical-align:top;
    margin:0;
    padding:0
}

Javascript

    $( '.contributors img[data-src]' ).each( function() {
        src = $(this).attr("data-src");
        $(this).attr('src',src);
    });

More information about templates here.

More information about blocks here.

Acknowledgements

Thank you to the following contributors:

  • Byrne Reese - original author, maintainer
  • Nathan Hernandez
  • Chris Northwood