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