Issues, PRs, Discussions status and labels in mkdocs.
Project description
mkdocs-issues-plugin
A plugin for showing the state and labels of issues, PRs and discussions (GitHub or GitLab) in mkdocs generated docs.
The following shows a rendering of index.md:
Usage
Install the 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.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4618688e372211f75a1c3b9082fed55f0d70f2f5cf9f56011cb80336ff10227 |
|
MD5 | de231e8d8d9ee1d516886af3247e2187 |
|
BLAKE2b-256 | 98cc4e7c0c3098d1ae9deeca639cde8652c39f44bae83441dfbde0d93f80122b |
Close
Hashes for mkdocs_issues_plugin-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67d7df54d5154a9f17d520b6351cc178f865062386035d3485cce00086ff4437 |
|
MD5 | 257efe3cfdba01bb62d960dee101d90b |
|
BLAKE2b-256 | ebe6726c5c0784d3e3b3c64a143f1e9ec51e5f937d83ca6b1de0f716f4126518 |