This is a plugin for MkDocs to display data from LeanIX.
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.
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.
plugins
- leanix:
api_token: asdfsa23kjlsadflkjsalkjf3 # or LEANIX_API_TOKEN environment variable
base_url: https://yourcompany.leanix.net/
workspace_name: test
Simply create a code block of the type leanix-factsheet
and insert the GUID of the factsheet to be shown:
```leanix-factsheet
d3bdeca8-8f79-4ee9-af4b-e390accf9f3d
```
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.