Use gitlab visual review with mkdocs.
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs-gitlab-review-plugin-1.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bfbadc806efcf449988ce7ee9bcd445f3555ee18ecc00ca07662d44d0da62097 |
|
MD5 | 16c7f57345ea4cde4e018aeaf7c17cf8 |
|
BLAKE2b-256 | e23b74573aa78c0092e3d318bbc332e732f6e278a55a5e9bbd6ab905f15891dc |
Close
Hashes for mkdocs_gitlab_review_plugin-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a0fae65e9a62f3e8a1c807d858bdc012246c9e1ca92bf567cf9e20797563c8c |
|
MD5 | 248d8f9003b8ae16bc7454a2baa488f5 |
|
BLAKE2b-256 | 5b0a1ef4d517eb3e513f48d19a2efa5428b902cc7f3739b21cf240312e3e8338 |