Metadata-Version: 2.1
Name: mkdocs-issues-plugin
Version: 0.1.1
Summary: Issues, PRs, Discussions status and labels in mkdocs.
Home-page: https://github.com/mihaigalos/mkdocs-issues-plugin
Author: Mihai Galos
Author-email: mihai@galos.one
License: MIT
Keywords: mkdocs plugin
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.0.4
Requires-Dist: mkdocs-material
Requires-Dist: requests

# mkdocs-issues-plugin

A plugin for showing the state and labels of issues, PRs and discussions (GitHub or GitLab) in mkdocs generated docs. 

The following shows a rendering of [index.md](https://github.com/mihaigalos/mkdocs-issues-plugin/blob/main/docs/index.md):

![screenshot](https://github.com/mihaigalos/mkdocs-issues-plugin/raw/main/screenshots/mkdocs-issues-plugin.png)

## Usage

Install the package:

```bash
pip install mkdocs-issues-plugin
```

Add the following lines to you `mkdocs.yaml`:
```yaml
plugins:
    - search
    - mkdocs-issues-plugin:
        log_level: "INFO"  # "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"
        configs:
          - service: 'github'
            base_url: 'https://github.com'
            api_url: 'https://api.github.com'
            token: '$GITHUB_TOKEN_PUBLIC'
```

Create a GitHub token and export it before running `mkdocs serve`:
```
export GITHUB_TOKEN_PUBLIC=ghp_***
mkdocs serve
```
