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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d481a3ec7ff67d542b42bd8a45c4efaf1ef58459b87db617ad8cefb4f92ace2 |
|
MD5 | b8bf5b0a8645e7344341085a4ceda059 |
|
BLAKE2b-256 | 73eaebdb7cad617c1d532f860779f584ef324dca59974af9f22b16b11b11b9b0 |
Close
Hashes for mkdocs_gitlab_review_plugin-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4648d6dc8f5acff247e29891c3f53043acfe644565c6485bda126cb3fd7ea4a6 |
|
MD5 | 1f06af46fceb54f27631a8a1c069afb8 |
|
BLAKE2b-256 | 53d7235ad7da8e28e384238475440f46f8a943b62c6622dca446c745f9a43ac3 |