Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.52 KB

README.md

File metadata and controls

66 lines (43 loc) · 2.52 KB

Table of Contents

Markdown Visual for Power BI

Markdown-visual is a simple markdown visualizer for Power BI. It uses the showdown.js library (a bidirectional Markdown to HTML converter) and is free from external dependencies. This tool enables you to render markdown content within your Power BI reports, making it easier to communicate information effectively.

Important Update: We have now added a sanitization layer to the HTML generated by showdown.js. We use the DOMPurify library to sanitize the HTML content before setting it to the target element. This significantly improves the safety of the HTML content by removing any potentially malicious content. However, it's important to note that no sanitization method can guarantee 100% safety. Therefore, always be cautious when dealing with HTML content, even when it has been sanitized. Please make sure to always use the sanitizeAndSetHtml method when you need to set HTML content to an element, to ensure that the content is as safe as possible.

Features

  • Seamless integration with Power BI reports.
  • No external dependencies required.
  • Easy rendering of markdown content.

Getting Started

Installation

To use markdown-visual in your Power BI reports, follow these steps:

  1. Download the latest release from the GitHub releases page.

  2. Add the markdown-visual to your report:

    • Click on "Insert" > "Visual."
    • Choose "Import a custom visual."
    • Select the downloaded .pbiviz file.

  3. Add the visual to your report and add a field that contains markdown. Please note that you might have to change the aggregation to "First" if nothing is shown.

Example Usage

# Heading 1
This is a simple markdown visualizer for Power BI.

## Heading 2
It supports various markdown features such as **bold**, *italic*, and [links](https://example.com).

- Lists
- Are
- Also
- Supported

Contributing

We welcome contributions to markdown-visual. If you'd like to contribute, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and ensure the code is well-documented.
  4. Submit a pull request, explaining the changes you made and why they are necessary.

License

This project is licensed under the MIT License - see the LICENSE file for details.