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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7b56c1ea3f43be2b1b20a9cd38abd016456071dc1078669be29e6b748585ed1 |
|
MD5 | 336dbb1daea523439d6ba20dd69f3623 |
|
BLAKE2b-256 | 4aa93f5e8f58310244f4aee7d47b893cb48ec9cc27ab9b38676c40904cd7c916 |
Close
Hashes for mkdocs_issues_plugin-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea8b9fd3b60a11aa7cee1877cbd6e203b6573088a9cf3a54984de8501db431b4 |
|
MD5 | 8b529894db177678d945ea7f91338a2a |
|
BLAKE2b-256 | 83c77dcb70a383e1280b3bcf6023b49a451618707ccca0085263aca47b208351 |