Issues status and labels in mkdocs.
Project description
mkdocs-issues-plugin
A plugin for showing the state and labels of issues (GitHub or GitLab) in mkdocs generated docs.
The following shows a rendering of index.md:
Usage
Install the mkdocs-issues-plugin 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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0dc14642e03223a6cf867f31ec8278675f434784e3bedc053b1616a67a4aa09e |
|
MD5 | 0d1e58a100eb6a3b32b96a502a0c7791 |
|
BLAKE2b-256 | 6652baa00a289027360493034a18963e6b2b04843efd76ba982b59178767cdb7 |
Close
Hashes for mkdocs_issues_plugin-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55b11eeee9261b0219a7a01f607bae5e309427691209fea6971b3a6c7b61d1fc |
|
MD5 | ad3cbc9b3f525880813b615f994516b7 |
|
BLAKE2b-256 | 81ae2137efa277504652c2c0fdb92bb15f19822b194756faa5a7cfdf93aa45ff |