https://github.com/daxartio/mkdocs-gitlab

Use Gitlab CI's variables for your docs
https://github.com/daxartio/mkdocs-gitlab

gitlab-ci mkdocs plugin

Last synced: 3 months ago
JSON representation

Use Gitlab CI's variables for your docs

• Host: GitHub
• URL: https://github.com/daxartio/mkdocs-gitlab
• Owner: daxartio
• License: mit
• Created: 2023-07-10T18:32:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-26T16:44:46.000Z (3 months ago)
• Last Synced: 2024-09-30T22:13:51.613Z (3 months ago)
• Topics: gitlab-ci, mkdocs, plugin
• Language: Python
• Homepage:
• Size: 61.5 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

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