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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6851ede853d54ba6cb58e1af14c4bc3a0321b8692547bb617404d142d9ba208 |
|
MD5 | 0fba8fc62de10ab1024ab1a260f09050 |
|
BLAKE2b-256 | ace1fff222879c58cac644977e7b524d2407dafb05d2974c3a5894e0778dd06d |
Close
Hashes for mkdocs_issues_plugin-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5b7a7fbebda3ef2a8766f3e2a31ec2b764ae250af0ee7875da8411ff517bfc5 |
|
MD5 | 20f28fb4417bf434a4f5605e129e6c10 |
|
BLAKE2b-256 | cb48da8f67322426713a09ac7e76c79b473a39664bb93c963ba17d475924aacc |