Skip to main content

Use Gitlab CI variables for your docs

Project description

MkDocs Gitlab

PyPI PyPI - Python Version GitHub last commit GitHub stars

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

site_name: Title

plugins:
- gitlab

License

Contribution

Contribution guidelines for this project

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_gitlab-1.4.0.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

mkdocs_gitlab-1.4.0-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_gitlab-1.4.0.tar.gz.

File metadata

  • Download URL: mkdocs_gitlab-1.4.0.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.8.18 Linux/6.8.0-1014-azure

File hashes

Hashes for mkdocs_gitlab-1.4.0.tar.gz
Algorithm Hash digest
SHA256 1f995683c6edfff39f36332162f4bcb63b1842beb043f27b1be5c3954ba6226f
MD5 8c07b27cd2913b5bbbb37b07d241bc9b
BLAKE2b-256 c8e427d8332c0b2a7a00f3810fa229ec7b7f7b1258f5b9acd058a21b42a03b8b

See more details on using hashes here.

File details

Details for the file mkdocs_gitlab-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_gitlab-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.8.18 Linux/6.8.0-1014-azure

File hashes

Hashes for mkdocs_gitlab-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2cb27a8de5288b5233798b5ec0e7792fce952aaed3de2ea6e4f07c9001f665e1
MD5 11f11171db3f391f3ff80b16d0aa7d41
BLAKE2b-256 a7a84fd6161d153f35d3a8d100423c410ec6b5f5e076c74f48b71c1e3b8e43df

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page