mkdocs-gitlab-review-plugin

Plugin for mkdocs to use GitLab Visual Review Apps

This plugin will automatically add the <script> tag for the Gitlab visual reviews. To use this you need to set up Review Apps and Merge Request pipelines.

Installing

Install with pip:

pip install mkdocs-gitlab-review-plugin

Using

To use this plugin, simply add the plugin to the mkdocs.yml

plugins:
  - gitlab_review

Configuration

There are a few configuration options available:

option	Default	Description
auth	false	A boolean to enable the Gitlab auth see Authentication for Visual Reviews
gitlab_url	https://gitlab.com	The url for the GitLab instance.
script_url	https://gitlab.com/assets/webpack/visual_review_toolbar.js	The url for the script to use
script_id	review-app-toolbar-script	The id in the HTML for the `<script>` tag.

Contributing

Pull Requests are welcome.
File bugs and suggestions in the GitHub Issues tracker.

Metadata

Release files for mkdocs-gitlab-review-plugin 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-gitlab-review-plugin 1.0.2
File	Size	Uploaded	Provenance
mkdocs-gitlab-review-plugin-1.0.2.tar.gz	3.1 kB	Apr 7, 2021	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-gitlab-review-plugin 1.0.2
File	Interpreter	ABI	Platform	Reset
mkdocs_gitlab_review_plugin-1.0.2-py3-none-any.whl 8.4 kB Apr 7, 2021 Without provenance	Python 3	none	any	Details

Total release size: 11.5 kB

Release files / mkdocs-gitlab-review-plugin-1.0.2.tar.gz

Download URL	mkdocs-gitlab-review-plugin-1.0.2.tar.gz
Size	3.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`bfbadc806efcf449988ce7ee9bcd445f3555ee18ecc00ca07662d44d0da62097`
BLAKE2b-256 checksum How to use checksums	`e23b74573aa78c0092e3d318bbc332e732f6e278a55a5e9bbd6ab905f15891dc`
Upload date	Apr 7, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.6.10`

Release files / mkdocs_gitlab_review_plugin-1.0.2-py3-none-any.whl

Download URL	mkdocs_gitlab_review_plugin-1.0.2-py3-none-any.whl
Size	8.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`0a0fae65e9a62f3e8a1c807d858bdc012246c9e1ca92bf567cf9e20797563c8c`
BLAKE2b-256 checksum How to use checksums	`5b0a1ef4d517eb3e513f48d19a2efa5428b902cc7f3739b21cf240312e3e8338`
Upload date	Apr 7, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.6.10`

Security for mkdocs-gitlab-review-plugin 1.0.2

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.