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.0.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 147f701862bea1fd4b8685b4c91a4d4561d37c45cb0e8edc99abf84d2983bd51 |
|
MD5 | 0882fedc5206a00615839d6d9541118d |
|
BLAKE2b-256 | a124dc605b47748435df11e49ceada46b98ffaea3eab620710da8ebed31c5d2a |
Close
Hashes for mkdocs_issues_plugin-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44c5a4132a3712131000ab2b1de316ec02d8ba9d1b6925930dd10061e1538b87 |
|
MD5 | 346d1aae0dffdbc2f314eb7c922db5ce |
|
BLAKE2b-256 | 14e4b7952e218c05ea020db545094268d0ec109cc0b6bfee22d6bc7bd6d392bd |