Metadata-Version: 2.1
Name: mkdocs-git-authors-plugin
Version: 0.1
Summary: Mkdocs plugin to display git authors of a page
Home-page: https://github.com/timvink/mkdocs-git-authors-plugin
Author: Tim Vink
Author-email: vinktim@gmail.com
License: MIT
Description: [![Actions Status](https://github.com/timvink/mkdocs-git-authors-plugin/workflows/pytest/badge.svg)](https://github.com/timvink/mkdocs-git-authors-plugin/actions)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-git-authors-plugin)
        ![PyPI](https://img.shields.io/pypi/v/mkdocs-git-authors-plugin)
        ![PyPI - Downloads](https://img.shields.io/pypi/dm/mkdocs-git-authors-plugin)
        [![codecov](https://codecov.io/gh/timvink/mkdocs-git-authors-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/timvink/mkdocs-git-authors-plugin)
         
        # mkdocs-git-authors-plugin
        
        [MkDocs](https://www.mkdocs.org/) 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](https://github.com/byrnereese/mkdocs-git-committers-plugin) for displaying authors' github user profiles
        - [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) for displaying the last revision date
        
        ## Setup
        
        Install the plugin using pip:
        
        ```bash
        pip install mkdocs-git-authors-plugin
        ```
        
        Activate the plugin in `mkdocs.yml`:
        
        ```yaml
        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. 
        
        Example output:
        
        > [John Doe](mailto:#), [Jane Doe](mailto:#) 
        
        ### In theme templates
        
        In theme template you will have access to the jinja2 variable `git_authors`, which contains a list of authors (as dicts), f.e.:
        
        ```python
        [{
            'name' : 'John Doe',
            'email' : 'abc@abc.com',
            'last_datetime' : datetime.datetime(),
            'lines' : 100,
            'contribution' : '100.0%'
        }]
        ```
        
        An example of how to use in your templates:
        
        ```django hljs
        {% 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 ``{{ git_authors_summary }}`` to insert a summary of the authors.
        
Keywords: mkdocs git contributors committers authors plugin
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.4
Description-Content-Type: text/markdown
