{"id":18671645,"url":"https://github.com/chwebdude/mkdocs-leanix-plugin","last_synced_at":"2026-04-29T01:04:45.151Z","repository":{"id":44746744,"uuid":"442593118","full_name":"chwebdude/mkdocs-leanix-plugin","owner":"chwebdude","description":"MkDocs plugin to show LeanIX data","archived":false,"fork":false,"pushed_at":"2022-01-27T09:23:22.000Z","size":166,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-27T22:03:09.477Z","etag":null,"topics":["leanix","mkdocs"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chwebdude.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-12-28T21:55:33.000Z","updated_at":"2023-08-04T07:35:56.000Z","dependencies_parsed_at":"2022-09-26T17:21:06.653Z","dependency_job_id":null,"html_url":"https://github.com/chwebdude/mkdocs-leanix-plugin","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chwebdude%2Fmkdocs-leanix-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chwebdude%2Fmkdocs-leanix-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chwebdude%2Fmkdocs-leanix-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chwebdude%2Fmkdocs-leanix-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chwebdude","download_url":"https://codeload.github.com/chwebdude/mkdocs-leanix-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239509019,"owners_count":19650698,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["leanix","mkdocs"],"created_at":"2024-11-07T09:06:34.324Z","updated_at":"2025-11-06T21:30:32.176Z","avatar_url":"https://github.com/chwebdude.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MkDocs LeanIX Plugin\n\nThis is a plugin for [MkDocs](mkdocs) to display data from [LeanIX](leanix).\n\n## Setup\n\nInstall the plugin using pip:\n\n`pip install mkdocs-leanix-plugin`\n\nActivate the plugin in `mkdocs.yml`:\n```yaml\nplugins:\n  - leanix  \n```\n\n\u003e **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.\n\nMore information about plugins in the [MkDocs documentation][mkdocs-plugins].\n\n## Configuration\n\n* `api_token` - The API token\n* `base_url` - Base URL of your LeanIX instance. Can be `https://yourorganization.leanix.net`\n* `material` [optional] - Set this to `true` if the material design template should be used. This requires the `pymdownx.tabbed` extension to be enabled\n\nAlternatively 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.\n\nWorkspace information (name and id) is retrived from the JWT token.\n\n### Sample\n\n```yaml\nplugins\n  - leanix:\n      api_token: asdfsa23kjlsadflkjsalkjf3 # or LEANIX_API_TOKEN environment variable\n      base_url: https://yourcompany.leanix.net/\n      workspace_name: test\n```\n\n## Usage\n\nSimply create a code block of the type `leanix-factsheet` and insert the GUID of the factsheet to be shown:\n\n### Sample\n\n````markdown\n```leanix-factsheet\nd3bdeca8-8f79-4ee9-af4b-e390accf9f3d\n```\n````\n\n### Customization\n\nOwn templates can be used. Add the path to the template after the factsheet GUID. The template must be inside the docs directory.\n\n````markdown\n```leanix-factsheet\nd3bdeca8-8f79-4ee9-af4b-e390accf9f3d\ntemplates/custom_factsheet.jinja2\n```\n````\n\nGet some inspiration of the [packed templates](gh-templates). A factsheet object will be provided as `fs` and can be printed out with `{{ fs }}`. Two helper functions are provided:\n\n* `get_user(userid)` - Gets friendly username from LeanIX and creates a Markdown mailto-link.\n* `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.\n\n## Screenshots\n\n### Overview\n\n![Overview](https://raw.githubusercontent.com/chwebdude/mkdocs-leanix-plugin/master/docs/img/Overview.png)\n\n### Documents\n\n![Documents](https://raw.githubusercontent.com/chwebdude/mkdocs-leanix-plugin/master/docs/img/Documents.png)\n\n### Subscriptions\n\n![Subscriptions](https://raw.githubusercontent.com/chwebdude/mkdocs-leanix-plugin/master/docs/img/Subscriptions.png)\n\n### Lifecycle\n\n![Lifecycle](https://raw.githubusercontent.com/chwebdude/mkdocs-leanix-plugin/master/docs/img/Lifecycle.png)\n\n[mkdocs]: https://www.mkdocs.org/\n[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/\n[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks\n[leanix]: https://www.leanix.net/\n[gh-templates]: https://github.com/chwebdude/mkdocs-leanix-plugin/tree/master/leanix/templates\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchwebdude%2Fmkdocs-leanix-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchwebdude%2Fmkdocs-leanix-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchwebdude%2Fmkdocs-leanix-plugin/lists"}