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:
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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a82795ae4ffba9d0104882826a6a9779de8608a72bcc34a0e84cb3470b5ac2a |
|
MD5 | e51cf62dc98dbe6cd5df60d954f59416 |
|
BLAKE2b-256 | 5513afb293248ff0e29a7551d42a31af90bf49bda21f458f4a26b97215105ba0 |
Close
Hashes for mkdocs_issues_plugin-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 35271f0143e029b1c97724c5a99d1f8f975c8a5e0be3a92c665aa42f7ffe3f18 |
|
MD5 | 8273ca51b9383035296bc18dae1eb343 |
|
BLAKE2b-256 | 10bb8c204c79658129f9fabf2b54d8b264c2ba9f899f0fca0b3837894fad8c0c |