{"id":17527128,"url":"https://github.com/VolkovLabs/business-text","last_synced_at":"2025-03-06T06:31:47.593Z","repository":{"id":40674999,"uuid":"291473513","full_name":"VolkovLabs/business-text","owner":"VolkovLabs","description":"The Business Text panel plugin allows you to construct a text visualization template from the values of a dataset returned by a data source query.","archived":false,"fork":false,"pushed_at":"2024-10-13T00:50:07.000Z","size":12570,"stargazers_count":81,"open_issues_count":2,"forks_count":13,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-15T05:21:04.319Z","etag":null,"topics":["grafana","handlebars","markdown","panel","plugin"],"latest_commit_sha":null,"homepage":"https://docs.volkovlabs.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VolkovLabs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"VolkovLabs"}},"created_at":"2020-08-30T13:15:33.000Z","updated_at":"2024-10-13T00:50:10.000Z","dependencies_parsed_at":"2023-12-25T17:51:00.799Z","dependency_job_id":"90cf7576-8ed4-44a0-82ae-f5c72e0db68f","html_url":"https://github.com/VolkovLabs/business-text","commit_stats":null,"previous_names":["volkovlabs/business-text"],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolkovLabs%2Fbusiness-text","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolkovLabs%2Fbusiness-text/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolkovLabs%2Fbusiness-text/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolkovLabs%2Fbusiness-text/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VolkovLabs","download_url":"https://codeload.github.com/VolkovLabs/business-text/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":220753131,"owners_count":16697311,"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":["grafana","handlebars","markdown","panel","plugin"],"created_at":"2024-10-20T15:03:14.086Z","updated_at":"2025-03-06T06:31:47.585Z","avatar_url":"https://github.com/VolkovLabs.png","language":"TypeScript","funding_links":["https://github.com/sponsors/VolkovLabs"],"categories":["TypeScript"],"sub_categories":[],"readme":"# Business Text for Grafana\n\n![Text](https://github.com/VolkovLabs/business-text/raw/main/src/img/screenshot.png)\n\n![Grafana](https://img.shields.io/badge/Grafana-11.4-orange)\n![CI](https://github.com/volkovlabs/business-text/workflows/CI/badge.svg)\n![E2E](https://github.com/volkovlabs/business-text/workflows/E2E/badge.svg)\n[![codecov](https://codecov.io/gh/VolkovLabs/business-text/branch/main/graph/badge.svg)](https://codecov.io/gh/VolkovLabs/business-text)\n[![CodeQL](https://github.com/VolkovLabs/business-text/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/VolkovLabs/business-text/actions/workflows/codeql-analysis.yml)\n\n## Introduction\n\nThe Business Text panel plugin allows you to construct a text visualization template from the values of a dataset returned by a data source query.\n\n[![Business Text plugin for Grafana | Use HTML, Markdown, JavaScript and CSS | Community use cases](https://raw.githubusercontent.com/volkovlabs/business-text/main/img/business-text.png)](https://youtu.be/UVMysEjouNo)\n\n## Requirements\n\n- Business Text panel 5.X requires **Grafana 10** or **Grafana 11**.\n- Dynamic Text panel 4.X requires **Grafana 9.2** or **Grafana 10**.\n- Dynamic Text panel 2.X and 3.X require **Grafana 8.5** or **Grafana 9**.\n- Dynamic Text panel 1.X requires **Grafana 7**.\n\n## Getting Started\n\nYou can install the Business Text panel from the [Grafana Plugins catalog](https://grafana.com/grafana/plugins/marcusolsson-dynamictext-panel/) or use the Grafana command line tool.\n\nFor the latter, please use the following command:\n\n```bash\ngrafana cli plugins install marcusolsson-dynamictext-panel\n```\n\n[![Install Business Suite plugins in Cloud, OSS, Enterprise | Open source community plugins](https://raw.githubusercontent.com/volkovlabs/.github/main/started.png)](https://youtu.be/1qYzHfPXJF8)\n\n## Highlights\n\n- Uses Monaco Code Editor with automatic JavaScript code formatting.\n- Supports [Markdown](https://commonmark.org/help/) and [Handlebars](https://handlebarsjs.com/guide/expressions.html#basic-usage).\n- Renders [markdown-it](https://github.com/markdown-it/markdown-it) into HTML elements.\n  - Supports the highlighting of code syntax using A11Y styles.\n- Provides code sanitization:\n  - HTML inside templates is sanitized using [XSS](https://jsxss.com/en/index.html).\n  - Can be disabled in the Grafana configuration through the `disable_sanitize_html` parameter.\n- Supports display of nested objects using the `{{json object}}` Handlebars helper.\n- Supports display of time global variables (`__to` and `__from`) as seconds, ISO timestamps, or formatted using the `dayjs` library.\n- Supports adding the Handlebars helpers and event handlers.\n- Supports adding CSS styles with dashboard variables.\n- Supports internationalization using custom helpers.\n\n## Documentation\n\n| Section                                                               | Description                                                   |\n| --------------------------------------------------------------------- | ------------------------------------------------------------- |\n| [Rendering](https://volkovlabs.io/plugins/business-text/content/)     | Explains how to create a visualization template for your data |\n| [Recipes](https://volkovlabs.io/plugins/business-text/recipes/)       | Useful snippets that you can use in your templates            |\n| [Features](https://volkovlabs.io/plugins/business-text/features/)     | Demonstrates panel features.templates                         |\n| [Tutorials](https://volkovlabs.io/plugins/business-text/tutorials/)   | Easy to follow tutorials                                      |\n| [Release Notes](https://volkovlabs.io/plugins/business-text/release/) | Stay up to date with the latest features and updates          |\n\n## Business Suite for Grafana\n\nThe Business Suite is a collection of open source plugins created and actively maintained by Volkov Labs.\n\nThe collection aims to solve the most frequent business tasks by providing an intuitive interface with detailed written documentation, examples, and video tutorials.\n\n[![Business Suite for Grafana](https://raw.githubusercontent.com/VolkovLabs/.github/main/business.png)](https://volkovlabs.io/plugins/)\n\n### Enterprise Support\n\nWith the [Business Suite Enterprise](https://volkovlabs.io/pricing/), you're not just getting a product, you're getting a complete support system. You'll have a designated support team ready to tackle any issues.\n\nYou can contact us via Zendesk, receive priority in feature requests and bug fixes, meet with us for in-person consultation, and get access to the Business Intelligence. It's a package that's designed to make your life easier.\n\n## Always happy to hear from you\n\n- Ask a question, request a new feature, or report an issue at [GitHub issues](https://github.com/volkovlabs/business-text/issues).\n- Subscribe to our [YouTube Channel](https://youtube.com/@volkovlabs) and leave your comments.\n- Become a [Business Suite sponsor](https://github.com/sponsors/VolkovLabs).\n\n## License\n\nApache License Version 2.0, see [LICENSE](https://github.com/volkovlabs/business-text/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FVolkovLabs%2Fbusiness-text","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FVolkovLabs%2Fbusiness-text","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FVolkovLabs%2Fbusiness-text/lists"}