Metadata-Version: 2.1
Name: mkdocs-gitlab
Version: 1.3.0
Summary: Use Gitlab CI variables for your docs
Home-page: https://pypi.org/project/mkdocs-gitlab
License: MIT
Author: Danil Akhtarov
Author-email: daxartio@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: mkdocs
Project-URL: Repository, https://github.com/daxartio/mkdocs-gitlab
Description-Content-Type: text/markdown

# 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)

