A MkDocs plugin to import LeanIX data
Project description
MkDocs LeanIX Plugin
This is a plugin for MkDocs to display data from LeanIX.
Setup
Install the plugin using pip:
pip install mkdocs-leanix-plugin
Activate the plugin in mkdocs.yml
:
plugins:
- leanix
Note: If you have no
plugins
entry in your config file yet, you'll likely also want to add thesearch
plugin. MkDocs enables it by default if there is noplugins
entry set, but now you have to enable it explicitly.
More information about plugins in the MkDocs documentation.
Configuration
api_token
- The API tokenbase_url
- Base URL of your LeanIX instance. Can behttps://yourorganization.leanix.net
material
[optional] - Set this totrue
if the material design template should be used. This requires thepymdownx.tabbed
extension to be enabled
Alternatively to the api_token
in the mkdocs.yml
a environment variable called LEANIX_API_TOKEN
can be set. This is likely the way in CI/CD scenarios.
Workspace information (name and id) is retrived from the JWT token.
Sample
plugins
- leanix:
api_token: asdfsa23kjlsadflkjsalkjf3 # or LEANIX_API_TOKEN environment variable
base_url: https://yourcompany.leanix.net/
workspace_name: test
Usage
Simply create a code block of the type leanix-factsheet
and insert the GUID of the factsheet to be shown:
Sample
```leanix-factsheet
d3bdeca8-8f79-4ee9-af4b-e390accf9f3d
```
Customization
Own templates can be used. Add the path to the template after the factsheet GUID. The template must be inside the docs directory.
```leanix-factsheet
d3bdeca8-8f79-4ee9-af4b-e390accf9f3d
templates/custom_factsheet.jinja2
```
Get some inspiration of the packed templates. A factsheet object will be provided as fs
and can be printed out with {{ fs }}
. Two helper functions are provided:
get_user(userid)
- Gets friendly username from LeanIX and creates a Markdown mailto-link.get_font_color(backgroundColor)
- Gets a black or white CSS color from a provided CSS background color. Can be used to ensure enough contrast between text and background color.
Screenshots
Overview
Documents
Subscriptions
Lifecycle
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
Hashes for mkdocs-leanix-plugin-1.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7d5fc16c9348a10a71fb6f1dc125ce2fea3b55dc01ab3eb60fe33dd1a0e2365 |
|
MD5 | 30f8229d50a8ec422044f32ce9798949 |
|
BLAKE2b-256 | eee06075705ed4e70edc2e993b8661a101b70923b2ef3a04a9284793d0ff9a2e |
Hashes for mkdocs_leanix_plugin-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c6d2132549e2432fd361cb390d3b792181f65858ad94238ae3c247fc0b3b7f9 |
|
MD5 | ac738f7cb6c52b0deeb759a8b6b42a3b |
|
BLAKE2b-256 | 10bcbe1b26b02c8238fe127fca41d302ef9b00ecba712d205c70ef40627e92f8 |