Read My MD
Read My MD is a VS Code extension for rendering Markdown with explicit CommonMark and GitHub Flavored Markdown coverage, plus the extra syntax that CommonMark calls out as common extensions:
- CommonMark core syntax: headings, block quotes, ordered and unordered lists, code spans, fenced and indented code blocks, links, images, HTML blocks, hard and soft line breaks, and link reference definitions
- GFM extensions: tables, task list items, strikethrough, and automatic link detection
- Common extensions mentioned by CommonMark: footnotes and definition lists
- Mermaid flowcharts and diagrams via fenced
mermaid code blocks
- Syntax-highlighted code blocks
- Admonition containers such as
::: info and ::: warning
- YAML front matter display
- Click-to-enlarge images and Mermaid diagrams in the live preview
- Right-click print and PDF export from the preview
- Live refresh while the source document changes
Usage
- Open a Markdown file in VS Code.
- Run
Read My MD: Open Preview from the Command Palette.
- Keep the preview open while editing. It refreshes automatically.
- Click an image or Mermaid diagram to open it in a larger modal view, then use the mouse wheel or
+ / - to zoom and drag to pan.
- Right-click inside the preview and choose
Print or Export as PDF.
Print and Export as PDF open a temporary browser-rendered version of the current preview, then trigger the system print dialog. Use the dialog's Save as PDF destination to write the PDF.
License
Read My MD is free to use, but it is not open source.
The source code is provided under a proprietary license. You may use the extension, but you may not redistribute, resell, or publish modified versions except where the license explicitly allows it.
See LICENSE.txt for the full terms.
GitHub Pages
A static landing page is included in docs/index.html.
If you decide to publish a static landing page later, the docs/ folder is ready to use as the site source.
Mermaid example
```mermaid
flowchart TD
Start --> Validate
Validate -->|ok| Render
Validate -->|error| Retry
```
Admonition example
::: warning Build note
This preview sanitizes raw HTML before rendering it in the webview.
:::
