mkdocs-gitlab


Namemkdocs-gitlab JSON
Version 1.4.0 PyPI version JSON
download
home_pagehttps://pypi.org/project/mkdocs-gitlab
SummaryUse Gitlab CI variables for your docs
upload_time2024-09-26 16:45:04
maintainerNone
docs_urlNone
authorDanil Akhtarov
requires_python<4.0,>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # MkDocs Gitlab

[![PyPI](https://img.shields.io/pypi/v/mkdocs-gitlab)](https://pypi.org/project/mkdocs-gitlab/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-gitlab)](https://www.python.org/downloads/)
[![GitHub last commit](https://img.shields.io/github/last-commit/daxartio/mkdocs-gitlab)](https://github.com/daxartio/mkdocs-gitlab)
[![GitHub stars](https://img.shields.io/github/stars/daxartio/mkdocs-gitlab?style=social)](https://github.com/daxartio/mkdocs-gitlab)

The plugin updates mkdocs config with Gitlab CI/CD variables.

- CI_PROJECT_TITLE
- CI_PROJECT_DESCRIPTION
- CI_PAGES_URL
- CI_PROJECT_URL
- CI_PROJECT_PATH

Also the pugin deletes the `[[_TOC_]]` or `[TOC]` tag.

## Installation

### pip

```
pip install mkdocs-gitlab
```

## Usage

```yaml
site_name: Title

plugins:
- gitlab

```

## License

* [MIT LICENSE](LICENSE)

## Contribution

[Contribution guidelines for this project](CONTRIBUTING.md)

            

Raw data

            {
    "_id": null,
    "home_page": "https://pypi.org/project/mkdocs-gitlab",
    "name": "mkdocs-gitlab",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Danil Akhtarov",
    "author_email": "daxartio@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/c8/e4/27d8332c0b2a7a00f3810fa229ec7b7f7b1258f5b9acd058a21b42a03b8b/mkdocs_gitlab-1.4.0.tar.gz",
    "platform": null,
    "description": "# MkDocs Gitlab\n\n[![PyPI](https://img.shields.io/pypi/v/mkdocs-gitlab)](https://pypi.org/project/mkdocs-gitlab/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-gitlab)](https://www.python.org/downloads/)\n[![GitHub last commit](https://img.shields.io/github/last-commit/daxartio/mkdocs-gitlab)](https://github.com/daxartio/mkdocs-gitlab)\n[![GitHub stars](https://img.shields.io/github/stars/daxartio/mkdocs-gitlab?style=social)](https://github.com/daxartio/mkdocs-gitlab)\n\nThe plugin updates mkdocs config with Gitlab CI/CD variables.\n\n- CI_PROJECT_TITLE\n- CI_PROJECT_DESCRIPTION\n- CI_PAGES_URL\n- CI_PROJECT_URL\n- CI_PROJECT_PATH\n\nAlso the pugin deletes the `[[_TOC_]]` or `[TOC]` tag.\n\n## Installation\n\n### pip\n\n```\npip install mkdocs-gitlab\n```\n\n## Usage\n\n```yaml\nsite_name: Title\n\nplugins:\n- gitlab\n\n```\n\n## License\n\n* [MIT LICENSE](LICENSE)\n\n## Contribution\n\n[Contribution guidelines for this project](CONTRIBUTING.md)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Use Gitlab CI variables for your docs",
    "version": "1.4.0",
    "project_urls": {
        "Homepage": "https://pypi.org/project/mkdocs-gitlab",
        "Repository": "https://github.com/daxartio/mkdocs-gitlab"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a7a84fd6161d153f35d3a8d100423c410ec6b5f5e076c74f48b71c1e3b8e43df",
                "md5": "11f11171db3f391f3ff80b16d0aa7d41",
                "sha256": "2cb27a8de5288b5233798b5ec0e7792fce952aaed3de2ea6e4f07c9001f665e1"
            },
            "downloads": -1,
            "filename": "mkdocs_gitlab-1.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "11f11171db3f391f3ff80b16d0aa7d41",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 4229,
            "upload_time": "2024-09-26T16:45:03",
            "upload_time_iso_8601": "2024-09-26T16:45:03.338225Z",
            "url": "https://files.pythonhosted.org/packages/a7/a8/4fd6161d153f35d3a8d100423c410ec6b5f5e076c74f48b71c1e3b8e43df/mkdocs_gitlab-1.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c8e427d8332c0b2a7a00f3810fa229ec7b7f7b1258f5b9acd058a21b42a03b8b",
                "md5": "8c07b27cd2913b5bbbb37b07d241bc9b",
                "sha256": "1f995683c6edfff39f36332162f4bcb63b1842beb043f27b1be5c3954ba6226f"
            },
            "downloads": -1,
            "filename": "mkdocs_gitlab-1.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "8c07b27cd2913b5bbbb37b07d241bc9b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 3583,
            "upload_time": "2024-09-26T16:45:04",
            "upload_time_iso_8601": "2024-09-26T16:45:04.529723Z",
            "url": "https://files.pythonhosted.org/packages/c8/e4/27d8332c0b2a7a00f3810fa229ec7b7f7b1258f5b9acd058a21b42a03b8b/mkdocs_gitlab-1.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-26 16:45:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "daxartio",
    "github_project": "mkdocs-gitlab",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-gitlab"
}
        
Elapsed time: 1.25976s