ReadMe is a custom Power BI visual for displaying familiar, GitHub-styled markdown content. Perfect for creating documentation dashboards, formatted release notes, and searchable data dictionaries in your Power BI reports.

• Current .pbiviz and example .pbix available here.
• Current release on AppSource can be found here.

• Current Release
• Table of Contents
• Getting Started
• Supported Markdown Features
• Formatting Options
• Development
• Contributing
• Changelog
  • v1.0.0.0
• Support
• License

While there are many ways to import your markdown, the sections below outlines best practices to import your raw markdown into PowerBi.

let
    Source = Web.Contents(
        "https://api.github.com/repos/USER/REPO/contents/PATH-TO/README.md",
        [
            Headers=[Accept="application/vnd.github.v3.raw"]
        ]
    ),
    Content = Text.FromBinary(Source),
    Table = #table({"Content"}, {{Content}})
in
    Table

Markdown_Measure = "

# Sales Dashboard

## Executive Summary
Our Q4 performance shows **strong growth** across all regions.

### Key Highlights
1. Revenue increased by 15%
2. Customer retention at 95%
3. New market expansion successful

"

let
    Source = #table({"Content"}, {{"# Sales Dashboard

## Executive Summary
Our Q4 performance shows **strong growth** across all regions.

### Key Highlights
1. Revenue increased by 15%
2. Customer retention at 95%
3. New market expansion successful

> **Note:** All figures are preliminary and subject to final audit.

| Metric | Q3 | Q4 | Change |
|--------|----|----|--------|
| Revenue | $1.2M | $1.4M | +17% |
| Customers | 1,250 | 1,380 | +10% |

For more details, see our documentation."}})
in
    Source

Highlight important information or quotes.

> This is a blockquote
> 
> It can span multiple lines
> 
> > And can be nested

Example Output:

This is a blockquote

It can span multiple lines

And can be nested

Display code with syntax highlighting.

```js
function example() {
    return "Hello World";
}
```

Output:

function example() {
    return "Hello World";
}

Create collapsible content sections.

<details>
<summary><strong>Click to expand</strong></summary>

### Hidden Content

This content is hidden by default and can be expanded by clicking the summary.
</details>

Output:

Click to expand

Hidden Content

This content is hidden by default and can be expanded by clicking the summary.

Add reference notes to your content.

This is a sentence with a footnote[^1].

[^1]: This is the footnote content.

Output:

This is a sentence with a footnote¹.

Create hierarchical document structure with headers.

# Main Title (H1)
## Section Title (H2)
### Subsection (H3)
#### Sub-subsection (H4)
##### Small Header (H5)
###### Tiny Header (H6)

Output:

Main Title (H1)

Section Title (H2)

Subsection (H3)

Sub-subsection (H4)

Small Header (H5)

Tiny Header (H6)

Embed images in your markdown content.

![Alt text](https://example.com/image.png)

Output:

Create internal navigation links in your documentation.

## Table of Contents
* [Getting Started](#getting-started)

## Getting Started
This section explains how to begin...

Note: The link #getting-started matches the header ## Getting Started (lowercase, spaces become hyphens).

Output:

Table of Contents

• Getting Started

Getting Started Test

This section explains how to begin...

Create ordered and unordered lists with proper nesting.

- Unordered list item
- Another item
  - Nested item

1. Ordered list item
2. Second item
   1. Nested numbered item

Output:

• Unordered list item
• Another item
  • Nested item

1. Ordered list item
2. Second item
   1. Nested numbered item

Create structured data tables with alignment.

| Header 1 | Header 2 | Header 3 |
|----------|:--------:|---------:|
| Left     | Center   | Right    |
| Data     | Data     | Data     |
| More     | Content  | Here     |

Output:

Header 1	Header 2	Header 3
Left	Center	Right
Data	Data	Data
More	Content	Here

Create interactive checkboxes.

- [x] Completed task
- [ ] Incomplete task

Output:

• Completed task
• Incomplete task

Emphasize text with bold, italic, and other formatting.

**Bold text** 
*italic text*
***Bold and italic***
~~Strikethrough text~~
<u>Underlined text</u>

Output:

Bold text
italic text
Bold and italic
Strikethrough text
Underlined text

Access these settings in Power BI's formatting pane:

• Node.js (v18+)
• Power BI Visual Tools: npm install -g powerbi-visuals-tools

• marked (^15.0.12) - Markdown parsing
• github-markdown-css (^5.8.1) - GitHub-style formatting
• dompurify (^3.2.6) - XSS protection
• d3 (7.9.0) - Data visualization utilities
• powerbi-visuals-api (~5.11.0) - Power BI integration
• powerbi-visuals-utils-formattingmodel (6.1.1) - Formatting utilities
• powerbi-visuals-utils-interactivityutils (^6.0.4) - Interaction utilities
• powerbi-visuals-utils-tooltiputils (^6.0.4) - Tooltip utilities

# Clone the repository
git clone https://github.com/MDeanLindsay/PBI-README.git

cd PBI-README/README

# Install dependencies
npm install

# Start development server
npm run start
# or
pbiviz start

# Create .pbiviz package
npm run package
# or 
pbiviz package

README/
├── src/
│   ├── visual.ts          # Main visual logic
│   └── settings.ts        # Formatting settings
├── style/
│   └── visual.less        # CSS styling
├── capabilities.json      # Visual capabilities
├── pbiviz.json           # Visual metadata
├── package.json          # Dependencies
├── tsconfig.json         # TypeScript configuration
└── eslint.config.mjs     # ESLint configuration

1. Fork the repository
2. Create a feature branch: git checkout -b feature/new-feature
3. Commit changes: git commit -m 'Add feature'
4. Push to branch: git push origin feature/new-feature
5. Open a pull request

• Added support for measure based markdown
• Added landing page for supported features
• Added styling for summary/detail drop downs

• Initial release

For questions, issues, or feature requests:

1. Check existing GitHub issues
2. Create a new issue with detailed description
3. Include markdown sample and expected vs actual behavior

MIT License

This project includes:

• github-markdown-css (MIT) - Copyright (c) Sindre Sorhus
• marked (MIT) - Copyright (c) 2011-2018, Christopher Jeffrey
• dompurify (Apache-2.0 OR MPL-2.0) - Copyright (c) Cure53

Made for those who hate native Power BI text tools.