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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d549a40878ed4016758fa557e7d3f34506ee2b190b4f2236d1119b72666ba313 |
|
MD5 | 41a65fa1901dcea8d5c7ad42c4c73151 |
|
BLAKE2b-256 | 6c2644f7e68dc69176a20d2880578d78ad859c44d628befeaa7724690549dc86 |
Close
Hashes for mkdocs_issues_plugin-0.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 553be08faf868f030988e4e717f781715d8e222694fb85d65b12f6361c73fe54 |
|
MD5 | bd9bf63376aab0bce52768ab4b3cec89 |
|
BLAKE2b-256 | 031c528860dd867b648360d0287c822ee96b3a86ce19b5a283b8946327dade47 |