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-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34fc98914f199ffc054a3f5529bd5568e7b10bb417e301343e2ba31d49f8873d |
|
MD5 | 30927f82abc2fe8f44ed6b9a4f7cae59 |
|
BLAKE2b-256 | 97c0e41d18dc1a56b57ff229caf6e1cef3d8adc21a4d5a7faee6598a559c04e5 |
Close
Hashes for mkdocs_gitlab_review_plugin-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1226be11844ebed69a93da97b6854c08e98d0d9caf6c537835e2feaffd37552c |
|
MD5 | a28f240f57d3c6235a879246ef39a220 |
|
BLAKE2b-256 | efeae78ed5ee86a6b3c40d11dfb02dabda7e8fadf1f86a1aa872d6a68f5a84fb |