Metadata-Version: 2.1
Name: mkdocs-git-latest-changes-plugin
Version: 0.0.12
Summary: MkDocs plugin that allows you to display a list of recently modified pages from the Git log
Author-email: Thomas Breitner <mail@thms.de>
License: MIT License
        
        Copyright (c) 2023 Thomas Breitner
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://tombreit.github.io/mkdocs-git-latest-changes-plugin/
Project-URL: Documentation, https://github.com/tombreit/mkdocs-git-latest-changes-plugin/blob/main/README.md
Project-URL: Repository, https://github.com/tombreit/mkdocs-git-latest-changes-plugin
Project-URL: Issues, https://github.com/tombreit/mkdocs-git-latest-changes-plugin/issues
Classifier: Framework :: MkDocs
Classifier: Topic :: Documentation
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.9.2
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs >=1.4
Requires-Dist: GitPython

# mkdocs-git-latest-changes-plugin

MkDocs plugin that allows you to display a list of recently modified pages from the Git log

## Setup

Install the plugin:

```bash
pip install mkdocs-git-latest-changes-plugin
```

Configure `mkdocs.yml`:

```yaml
plugins:
  - git-latest-changes
```

## Demo

https://tombreit.github.io/mkdocs-git-latest-changes-plugin/

## Usage

Use `{{ latest_changes }}` in your Markdown page(s) where the latest git changes should be inserted as a table.

## Hints

- This plugin depends of having any commits in the current branch.
- For linked git commit hashes and filenames, the MkDocs config variable `repo_url` must be set and point to a Github or Gitlab repository.
- Log level: Request debug information for this plugin via MkDocs `--verbose` command line flag.
