Description:

mkdocsgitlabreviewplugin 1.0.2

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.

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter