mkdocs-issues-plugin

Name	mkdocs-issues-plugin JSON
Version	0.1.1 JSON
	download
home_page	https://github.com/mihaigalos/mkdocs-issues-plugin
Summary	Issues, PRs, Discussions status and labels in mkdocs.
upload_time	2024-07-24 15:24:49
maintainer	None
docs_url	None
author	Mihai Galos
requires_python	>=3.8
license	MIT
keywords	mkdocs plugin
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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](https://github.com/mihaigalos/mkdocs-issues-plugin/blob/main/docs/index.md):

![screenshot](https://github.com/mihaigalos/mkdocs-issues-plugin/raw/main/screenshots/mkdocs-issues-plugin.png)

## Usage

Install the package:

```bash
pip install mkdocs-issues-plugin
```

Add the following lines to you `mkdocs.yaml`:
```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
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mihaigalos/mkdocs-issues-plugin",
    "name": "mkdocs-issues-plugin",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "mkdocs plugin",
    "author": "Mihai Galos",
    "author_email": "mihai@galos.one",
    "download_url": "https://files.pythonhosted.org/packages/98/cc/4e7c0c3098d1ae9deeca639cde8652c39f44bae83441dfbde0d93f80122b/mkdocs_issues_plugin-0.1.1.tar.gz",
    "platform": null,
    "description": "# mkdocs-issues-plugin\n\nA plugin for showing the state and labels of issues, PRs and discussions (GitHub or GitLab) in mkdocs generated docs. \n\nThe following shows a rendering of [index.md](https://github.com/mihaigalos/mkdocs-issues-plugin/blob/main/docs/index.md):\n\n![screenshot](https://github.com/mihaigalos/mkdocs-issues-plugin/raw/main/screenshots/mkdocs-issues-plugin.png)\n\n## Usage\n\nInstall the package:\n\n```bash\npip install mkdocs-issues-plugin\n```\n\nAdd the following lines to you `mkdocs.yaml`:\n```yaml\nplugins:\n    - search\n    - mkdocs-issues-plugin:\n        log_level: \"INFO\"  # \"DEBUG\", \"INFO\", \"WARNING\", \"ERROR\", \"CRITICAL\"\n        configs:\n          - service: 'github'\n            base_url: 'https://github.com'\n            api_url: 'https://api.github.com'\n            token: '$GITHUB_TOKEN_PUBLIC'\n```\n\nCreate a GitHub token and export it before running `mkdocs serve`:\n```\nexport GITHUB_TOKEN_PUBLIC=ghp_***\nmkdocs serve\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Issues, PRs, Discussions status and labels in mkdocs.",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/mihaigalos/mkdocs-issues-plugin"
    },
    "split_keywords": [
        "mkdocs",
        "plugin"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ebe6726c5c0784d3e3b3c64a143f1e9ec51e5f937d83ca6b1de0f716f4126518",
                "md5": "257efe3cfdba01bb62d960dee101d90b",
                "sha256": "67d7df54d5154a9f17d520b6351cc178f865062386035d3485cce00086ff4437"
            },
            "downloads": -1,
            "filename": "mkdocs_issues_plugin-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "257efe3cfdba01bb62d960dee101d90b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 6897,
            "upload_time": "2024-07-24T15:24:48",
            "upload_time_iso_8601": "2024-07-24T15:24:48.103981Z",
            "url": "https://files.pythonhosted.org/packages/eb/e6/726c5c0784d3e3b3c64a143f1e9ec51e5f937d83ca6b1de0f716f4126518/mkdocs_issues_plugin-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "98cc4e7c0c3098d1ae9deeca639cde8652c39f44bae83441dfbde0d93f80122b",
                "md5": "de231e8d8d9ee1d516886af3247e2187",
                "sha256": "a4618688e372211f75a1c3b9082fed55f0d70f2f5cf9f56011cb80336ff10227"
            },
            "downloads": -1,
            "filename": "mkdocs_issues_plugin-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "de231e8d8d9ee1d516886af3247e2187",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 6251,
            "upload_time": "2024-07-24T15:24:49",
            "upload_time_iso_8601": "2024-07-24T15:24:49.333121Z",
            "url": "https://files.pythonhosted.org/packages/98/cc/4e7c0c3098d1ae9deeca639cde8652c39f44bae83441dfbde0d93f80122b/mkdocs_issues_plugin-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-24 15:24:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mihaigalos",
    "github_project": "mkdocs-issues-plugin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-issues-plugin"
}