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:

screenshot

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

Metadata

Release files for mkdocs-issues-plugin 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-issues-plugin 0.1.2
File	Size	Uploaded
mkdocs_issues_plugin-0.1.2.tar.gz	6.4 kB	Jul 24, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-issues-plugin 0.1.2
File	Interpreter	ABI	Platform	Reset
mkdocs_issues_plugin-0.1.2-py3-none-any.whl 7.0 kB Jul 24, 2024	Python 3	none	any	Details

Total release size: 13.4 kB

Release files / mkdocs_issues_plugin-0.1.2.tar.gz

Download URL	mkdocs_issues_plugin-0.1.2.tar.gz
Size	6.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`e89cd1562bf897ab86abc07ad962398a01f6cc5ac12c83c2516c8cddaf5e28c0`
BLAKE2b-256 checksum How to use checksums	`b873e51cdf8e8368df9c0692a6a5e62b03463ba94e0c43a686ad1b0cbbe7edbf`
Upload date	Jul 24, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.1.0 CPython/3.12.4`

Release files / mkdocs_issues_plugin-0.1.2-py3-none-any.whl

Download URL	mkdocs_issues_plugin-0.1.2-py3-none-any.whl
Size	7.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c6edbcaec519dda90e36118fb35e45db04220566f6c18c708fae8d6ec9876fbd`
BLAKE2b-256 checksum How to use checksums	`a5ee782a7d89ef471257e35048cf87bd24a1ae38486b4655801166d5381a64c3`
Upload date	Jul 24, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.1.0 CPython/3.12.4`