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
- issues:
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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd34adaab8702e3ea2784506c307a7c8e174b6541ad7212163e056a5c92548b8 |
|
MD5 | ee606127d10e40f87499c850f92c69af |
|
BLAKE2b-256 | 4ade309706512f6db7c2de944ff4c28cc2b7f1f4d39779897cb919e251d39aa4 |
Close
Hashes for mkdocs_issues_plugin-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b27d9a5deed205da6a717a9cb729a7dc3d45dce7fc521cab175ee0c4e0c8e119 |
|
MD5 | 91d36ed3400f91f997a1ef5cae9bbab4 |
|
BLAKE2b-256 | 913c6edcee70258b5c8ae9d11e81c3c5620bc4554eba51cf6eab12662ef76e52 |