Issues, PRs, Discussions status and labels in mkdocs.
Project description
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:
Usage
Install the package:
pip install mkdocs-issues-plugin
Add the following lines to you mkdocs.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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs_issues_plugin-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 739426bd11d162fe87c3f5920858d95ac1fd8369065bca148d43f303cd7c47e6 |
|
MD5 | 15cc9f7089410eff70f1cb08943e60d4 |
|
BLAKE2b-256 | 798a9d9a2b66d74326a302feeb1af294fc9a8424f095d625b535df040c37a1d6 |
Close
Hashes for mkdocs_issues_plugin-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f765dd35fa24709aa5b3db74ec2811efea38985ccd753b894cb0d52c546f336 |
|
MD5 | fa5b5b63a30a2192ebcb1ced42f15870 |
|
BLAKE2b-256 | 40cf72c5a157c4f0f3dfd6a859ca5cfcb55e9991f0d1dd4fdafb44acf1d6dc98 |