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'
#graphql_api_url: 'https://company.tech/api/v3/graphql' # Optional, defaults to {api_url}/graphql if not set
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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e89cd1562bf897ab86abc07ad962398a01f6cc5ac12c83c2516c8cddaf5e28c0 |
|
MD5 | eb203e7a402492b5638bbb28cc343115 |
|
BLAKE2b-256 | b873e51cdf8e8368df9c0692a6a5e62b03463ba94e0c43a686ad1b0cbbe7edbf |
Close
Hashes for mkdocs_issues_plugin-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c6edbcaec519dda90e36118fb35e45db04220566f6c18c708fae8d6ec9876fbd |
|
MD5 | 747d853da98d97c2b62796a3a82b5fa4 |
|
BLAKE2b-256 | a5ee782a7d89ef471257e35048cf87bd24a1ae38486b4655801166d5381a64c3 |