{"id":41253885,"url":"https://github.com/obegron/mkdocs-pipeline-visualizer","last_synced_at":"2026-01-23T01:45:01.523Z","repository":{"id":252116498,"uuid":"839288937","full_name":"obegron/mkdocs-pipeline-visualizer","owner":"obegron","description":"Generates MD documentation from tekton pipelines and tasks","archived":false,"fork":false,"pushed_at":"2025-09-17T18:04:58.000Z","size":120,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-05T02:00:58.961Z","etag":null,"topics":["mkdocs-plugin","tekton","tekton-pipelines"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/obegron.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-08-07T10:03:40.000Z","updated_at":"2025-11-16T01:56:42.000Z","dependencies_parsed_at":"2025-01-20T01:19:54.729Z","dependency_job_id":"46b41e55-b30d-4c68-a288-2c622f6a5ddb","html_url":"https://github.com/obegron/mkdocs-pipeline-visualizer","commit_stats":null,"previous_names":["obegron/mkdocs-pipeline-visualizer"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/obegron/mkdocs-pipeline-visualizer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obegron%2Fmkdocs-pipeline-visualizer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obegron%2Fmkdocs-pipeline-visualizer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obegron%2Fmkdocs-pipeline-visualizer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obegron%2Fmkdocs-pipeline-visualizer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/obegron","download_url":"https://codeload.github.com/obegron/mkdocs-pipeline-visualizer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obegron%2Fmkdocs-pipeline-visualizer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28677711,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T01:00:35.747Z","status":"ssl_error","status_checked_at":"2026-01-23T01:00:19.529Z","response_time":144,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["mkdocs-plugin","tekton","tekton-pipelines"],"created_at":"2026-01-23T01:45:01.295Z","updated_at":"2026-01-23T01:45:01.514Z","avatar_url":"https://github.com/obegron.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-pipeline-visualizer\n\n## Introduction\n\n\u003e The mkdocs-pipeline-visualizer plugin automates the creation of up-to-date documentation for your Tekton pipelines and tasks.\n\n![Visualization of a Tekton pipeline using mkdocs-pipeline-visualizer plugin](https://raw.githubusercontent.com/obegron/mkdocs-pipeline-visualizer/main/example/tekton/pipeline-view.png)\n\n## Installation\n\nTo install the mkdocs-pipeline-visualizer plugin, run the following command:\n\n```console\n$ pip install mkdocs-pipeline-visualizer\n```\n\n### Example Configuration\n\nBelow is an example of how to configure mkdocs.yaml:\n\n```yaml\nsite_name: Tekton\ndocs_dir: ./tekton\n\nnav:\n  - Home: index.md\n\nplugins:\n  - pipeline-visualizer\n\nmarkdown_extensions:\n  plantuml_markdown:\n    server: http://www.plantuml.com/plantuml\n\ntheme:\n  name: material\n  features:\n    - navigation.sections\n```\n\n## Configuration\n\nBy default, the plugin creates two sections at the root level: Pipelines and Tasks. The docs_dir should point to the location of pipelines and tasks manifests.\n\n| Config parameter | Type | Description | Default | Since |\n| ---------------- | ---- | ----------- | ------- | -------------- |\n| `plantuml_graphs`| **[bool]** | Controls if pipeline graph should be visible | `True` | 0.1.5 |\n| `plantuml_graph_direction` | **[string]** | TB(top to bottom) or LR(left to right) | `TB` | 0.1.3 |\n| `plantuml_theme` | **[string]** | Any theme listed on https://plantuml.com/theme to style e.g hacker, spacelab | `_none_` | 0.1.3 |\n| `nav_generation` | **[bool]** | Automatically generate navigation tree | `True` | 0.2.0 |\n| `nav_hide_empty_sections` | **[bool]** | Hide empty navigation sections | `False` | 0.4.0 |\n| `nav_group_tasks_by_category` | **[bool]** | Group tasks in navigation by `tekton.dev/categories` annotation | `False` | 0.3.0 |\n| `nav_section_pipelines` | **[string]** | Section name used for pipelines | `Pipelines` | 0.2.0 |\n| `nav_section_tasks` | **[string]** | Section name used for tasks | `Tasks` | 0.2.0 |\n| `nav_section_stepactions` | **[string]** | Section name used for stepactions | `StepActions` | 0.4.0 |\n| `nav_pipeline_grouping_offset` | **[string]** | Controls how pipeline file paths are represented in the navigation structure. The format is \"start:end\", where: \"start\" is the index of the first directory to include \"end\" is the index of the last directory to include (use negative numbers to count from the end) | `None` | 0.2.0 |\n| `nav_task_grouping_offset` | **[string]** | Same as `nav_pipeline_grouping_offset` but for tasks | `None` | 0.2.0 |\n| `nav_stepaction_grouping_offset` | **[string]** | Same as `nav_pipeline_grouping_offset` but for stepactions | `None` | 0.4.0 |\n| `log_level` | **[string]** | `DEBUG INFO WARNING ERROR CRITICAL` | `INFO` | 0.2.0 |\n| `nav_category_mapping` | **[dict]** | Custom category name mappings | `{}` | 0.3.0 |\n\n### Example for `nav_pipeline_grouping_offset`\n\nLet's say you have a pipeline file located at:\n\n```\n./pipelines/project-a/deployment/my-pipeline.yaml\n```\n\nHere's how different `nav_pipeline_grouping_offset` values would affect the navigation structure:\n\n- `\"0:-1\"`: Includes all directories except the last one (which is the file name).\n  - Result: `Pipelines \u003e pipelines \u003e project-a \u003e deployment \u003e my-pipeline`\n\n- `\"1:-1\"`: Skips the first directory and includes all others except the last one.\n  - Result: `Pipelines \u003e project-a \u003e deployment \u003e my-pipeline`\n\n- `\"1:-2\"`: Skips the first directory and excludes the last two (the last directory and the file name).\n  - Result: `Pipelines \u003e project-a \u003e my-pipeline`\n\n- `None` (default): All pipelines are placed directly under the `nav_section_pipelines` section.\n  - Result: `Pipelines \u003e my-pipeline`\n\n\n## How To\n\n### Customizing Documentation Locations\n\nYou can change the location of the documentation sections by placing an empty section in any location of the navigation (nav) and setting it to the value of `nav_section_pipelines` or `nav_section_tasks`:\n\n```yaml\nsite_name: Tekton\ndocs_dir: ./tekton\n\nnav:\n  - Home: index.md\n  - Tekton:\n    - \"Tasks\": []\n    - \"Pipelines\": []\n    - \"StepActions\": []\n\nplugins:\n  - pipeline-visualizer\n```\n\n### Customizing Menu Section Names and Graph Themes\n\nTo change the names of the menu sections and apply a custom graph theme, use the following configuration:\n\n```yaml\nsite_name: Tekton\ndocs_dir: ./tekton\n\nnav:\n  - Home: index.md  \n  - Tekton:\n    - \"🛠️ Tasks\": []\n    - \"🚀 Pipelines\": []\n    - \"⚙️ StepActions\": []\n\nplugins:\n  - pipeline-visualizer:\n      plantuml_theme: hacker\n      nav_section_tasks: \"🛠️ Tasks\"\n      nav_section_pipelines: \"🚀 Pipelines\"\n      nav_section_stepactions: \"⚙️ StepActions\"      \n```\n\n### Category Name Mapping\n\nYou can customize how task categories appear in the navigation by providing mappings in the `nav_category_mapping` configuration:\n\n```yaml\nplugins:\n  - pipeline-visualizer:\n      nav_category_mapping:\n        \"Code Quality\": \"Quality Tools\"\n        \"Build\": \"Build Tools\"\n        \"Deploy\": \"Deployment\"\n```\n\n## Changelog\n\n### 0.4.2\n\n#### Fixed\n* Fix rendering of StepAction\n\n### 0.4.1\n\n#### Fixed\n* Corrected markdown code block rendering for scripts.\n\n### 0.4.0\n\n#### Added\n* Support for Tekton StepActions.\n* `nav_section_stepactions` and `nav_stepaction_grouping_offset` configuration options.\n* Updated navigation generation to include StepActions.\n* Updated example configuration and documentation.\n\n#### Fixed\n* Resolved infinite loop issue with `mkdocs serve` by preventing unnecessary file writes when content is unchanged.\n\n### 0.3.0\n\n#### Added\n* Optional support for categorization of tasks in navigation using `tekton.dev/categories` annotation.\n\n### 0.2.1\n\n#### Added\n* Example in `example/`.\n* Visualization for step templates in tasks.\n\n#### Fixed\n* Corrected typo in `plantuml_graphs` attribute name (from `plantum_graphs`).\n* Corrected typo in `nav_task_grouping_offset` attribute name (from `nav_tasks_grouping_offset`).\n\n### 0.2.0\n\n#### Added\n* Navigation generation feature with customizable sections for pipelines and tasks.\n* Support for grouping pipelines and tasks in the navigation.\n* Improved logging with configurable log levels.\n* Version-based sorting for resources in navigation.\n\n#### Changed\n* Improved visualization of tasks, parameters, and workspaces.\n* Better handling of different script types in task steps.\n\n#### Fixed\n* Various bug fixes and code structure improvements.\n\n### 0.1.8\n\n#### Removed\n* Version of tasks from the documentation until a better presentation is available.\n\n### 0.1.7\n\n#### Fixed\n* Issue with backslashes (`\\`) in usage examples.\n* Example in the README.\n\n### 0.1.6\n\n#### Added\n* Version of pipeline/task when available.\n\n#### Fixed\n* Hide workspaces for tasks when none are used.\n\n### 0.1.5\n\n#### Added\n* Sample on how to use a task in a pipeline.\n* `plantuml_graphs` option to make PlantUML graphs optional.\n\n#### Fixed\n* Removed extra `---` after tasks.\n* Processing of only pipelines or tasks.\n\n### 0.1.4\n\n#### Added\n* Display of all tasks in the `finally` block.\n\n### 0.1.3\n\n#### Added\n* Configuration for graph direction (`plantuml_graph_direction`).\n* Configuration for PlantUML theme (`plantuml_theme`).\n* Display of references to `configMaps`.\n\n### 0.1.2\n\n#### Changed\n* Presentation of default and empty values.\n\n#### Removed\n* Unused code.\n\n### 0.1.1\n\n#### Fixed\n* Issue with multidoc YAML.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobegron%2Fmkdocs-pipeline-visualizer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fobegron%2Fmkdocs-pipeline-visualizer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobegron%2Fmkdocs-pipeline-visualizer/lists"}