MDV(1)

NAME

mdvMDV — a Markdown superset for documents, dashboards, and slides with embedded data and visualizations. HTML + PDF…

SYNOPSIS

INFO

456 stars
12 forks
0 views
TypeScriptDeveloper Tools

DESCRIPTION

MDV — a Markdown superset for documents, dashboards, and slides with embedded data and visualizations. HTML + PDF export, live preview, VS Code extension.

README

MDV — Markdown Data & Visualization

Write reports, dashboards, and slide decks in a single Markdown-native workflow, then export to self-contained HTML or PDF — no rebuilding the same content across a doc tool, a BI tool, and a deck tool.

Charts, KPI cards, tables, and styled regions come from nothing more complicated than fenced code blocks and named styles. .mdv is strict CommonMark plus four additions:

  1. YAML front-matter for title, theme, named styles, and dataset references.
  2. Fenced blocks for data/visuals: ```chart type=bar x=region y=sales.
  3. ::: containers for styled regions and layout: ::: callout / ::: columns.
  4. ::: toc for an auto-generated table of contents.

No selectors, no classes, no expressions, no code. Themes provide defaults, named styles give reusable looks, the renderer does the rest.

Quick look

---
title: Q1 Report
theme: report
data:
  sales: ./data/sales.csv
---

::: toc :::

Q1 Results

label, value, delta
Total revenue, $2.06M, +14%
New customers, 1238, +8%

Renders to self-contained HTML (charts are inline SVG, no JS runtime) and PDF. Lives inside VS Code via a side-by-side preview.

Getting started

git clone <repo> mdv
cd mdv
npm install
npm run build

Render an example

node packages/mdv-cli/dist/index.js render examples/09-full-report.mdv

Or: live preview with auto-reload

node packages/mdv-cli/dist/index.js preview examples/09-full-report.mdv

See docs/getting-started.md for a walkthrough.

Documentation

Examples

examples/ contains 10 sample files covering every feature. Rendered HTML is in examples/out/.

Status

SEE ALSO

clihub4/25/2026MDV(1)