comark-vega

comark-vega

A Comark plugin for Vega and Vega-Lite charts — turns fenced blocks and directives into <Vega> component nodes.

Ships a Vue renderer; parse-time SVG/img is an opt-in for static docs.

Install

pnpm add comark-vega vega vega-lite

comark, vega, and vega-lite are peer dependencies.

For the Vue renderer:

pnpm add vue @comark/vue

vue is an optional peer for comark-vega/vue.

Usage

Plugin only (parse-time SVG / static docs)

import { parseMarkdown } from 'comark'
import vega from 'comark-vega'

const tree = await parseMarkdown(content, {
  plugins: [vega()],
})

Use ::vl, ::vg, ::chart, or mark shortcuts when you want inline SVG at parse time.

Plugin + Vue renderer (recommended for apps)

<script setup lang="ts">
import { Markdown } from '@comark/vue'
import vega, { Vega } from 'comark-vega/vue'
</script>

<template>
  <Suspense>
    <Markdown
      :plugins="[vega()]"
      :components="{ Vega }"
    >{{ content }}</Markdown>
  </Suspense>
</template>

Then use fenced blocks or ::vega in Markdown:

```vega-lite
{ "mark": "bar", "data": { "values": […] }, "encoding": { … } }
```

::vega{:spec="report.chart" engine="vega-lite"}

React / Svelte renderers can follow the same export shape later (comark-vega/react, …). Until then, use mountVegaView from comark-vega (or comark-vega/vue) in a custom component.

Entry points

1 — Fenced ````vega` block (literal / static)

Code-fence content is opaque to Comark's parser — {…} is never treated as directive attribute syntax, so raw JSON is always safe here. The block is replaced in the AST with a ['Vega', { spec, engine }] component node.

```vega-lite
{
  "$schema": "https://vega.github.io/schema/vega-lite/v6.json",
  "mark": "bar",
  "data": { "values": [{ "x": "A", "y": 4 }, { "x": "B", "y": 6 }] },
  "encoding": {
    "x": { "field": "x", "type": "nominal" },
    "y": { "field": "y", "type": "quantitative" }
  }
}
```

Use vega` for a full Vega spec; use vega-litefor a Vega-Lite spec. When$schema` is present, the engine is auto-detected from the URL regardless of the language tag.

2 — ::vega component directive (dynamic / bound)

:prop="expression" attrs are preserved verbatim for @comark/binding to resolve against frontmatter or runtime data at render time. Plain prop="value" attrs remain literal strings.

::vega{:spec="report.chart" engine="vega-lite"}

Multiple bindings are all preserved:

::vega{:spec="dashboard.revenue" :width="panel.w" engine="vega-lite"}

A code-fenced body can supply a literal spec when no :spec binding is present:

::vega{engine="vega-lite"}
```
{ "mark": "bar", … }
```
::

Shared <Vega> component node

Both entry points produce identical ['Vega', VegaNodeAttrs] AST nodes. Map them with the shipped Vue component (components="{ Vega }") or a custom renderer.

Component props

Invalid specs soft-fail: the component shows a <pre class="vega-error"> message and does not throw.

import type { VegaNodeAttrs } from 'comark-vega'
import { mountVegaView } from 'comark-vega'

Inline-SVG directives

For static output without a runtime component, these directives render the chart as inline SVG at parse time.

::vl — Vega-Lite

The spec JSON must be wrapped in a code fence inside the block body. Comark reserves {...} syntax in block bodies for directive attributes; a code fence is the only safe way to pass JSON without mangling.

::vl{width="500" height="300" output="svg"}
```
{
  "$schema": "https://vega.github.io/schema/vega-lite/v6.json",
  "mark": "bar",
  "data": {
    "values": [
      { "product": "Valves", "sales": 42000 },
      { "product": "Pipes",  "sales": 31500 }
    ]
  },
  "encoding": {
    "x": { "field": "sales",   "type": "quantitative" },
    "y": { "field": "product", "type": "nominal" }
  }
}
```
::

Alias: ::vega-lite.

::vg — Full Vega

::vg
```
{
  "$schema": "https://vega.github.io/schema/vega/v6.json",
  "width": 300,
  "height": 150,
  "data": [{ "name": "table", "values": [{ "x": "A", "y": 4 }] }],
  "marks": [{ "type": "rect", "from": { "data": "table" }, ... }]
}
```
::

Note: ::vega was previously an alias for ::vg. It is now a separate component directive that produces a <Vega> node — see Entry points. Use ::vg for full-Vega inline SVG.

::chart — Auto-detect engine

::chart{engine="vega-lite"}
{ ... }
::

Engine is inferred in this order:

1. engine= attr (vega-lite | vega)
2. Directive tag (::vl → vega-lite, ::vg → vega)
3. $schema URL in spec
4. Presence of mark/layer/hconcat/… → vega-lite; marks/signals/… → vega
5. Default: vega-lite

Mark-shortcut directives

Mark shortcuts are sugar over ::vl that inject the mark field when it is absent from the spec body.

Example — inline donut chart:

::chart-arc{width="280" height="280"}
```
{
  "data": { "values": [{ "label": "Done", "n": 74 }, { "label": "Todo", "n": 26 }] },
  "encoding": {
    "theta": { "field": "n",     "type": "quantitative" },
    "color": { "field": "label", "type": "nominal" }
  }
}
```
::

Spec sources

For <Vega> component entry points

For inline-SVG directives

The chart spec is resolved from these sources (in priority order):

1. Code-fenced block body — the recommended format. Comark treats bare {...} in directive block bodies as directive attribute syntax. Wrapping the spec in a code fence preserves it as raw text:

::vl
```
{ "mark": "bar", ... }
```
::

2. spec= attr — only reliable for simple, flat specs with at most one level of object nesting. Comark's attr parser may misinterpret nested braces inside quoted attr values.

Output modes

Control the generated node type with the output= attr or a frontmatter default:

Frontmatter defaults

Set global defaults in the document frontmatter under the vega key. Per-directive attrs always take precedence.

---
vega:
  output: svg
  engine: vega-lite
  width: 600
  height: 300
  scaleFactor: 2
  config:
    background: transparent
    axis:
      grid: false
---

::vl
```
{ ... }
```
::

Plugin options

Pass defaults via the plugin factory — frontmatter values override these:

import vega from 'comark-vega'

const plugins = [
  vega({
    vega: {
      output: 'svg',
      engine: 'vega-lite',
      width: 500,
      height: 300,
      config: {
        background: null,
      },
    },
  }),
]

Error handling

Invalid specs produce a <pre class="vega vega-error vega-{tag}"> fallback node instead of throwing, so the rest of the document still renders. A console.warn is emitted with the error details.

Binding behaviour

Credits

Chart rendering is provided by vega (BSD-3) and vega-lite (BSD-3), maintained by the Vega team. This plugin wraps those libraries for use with Comark; it does not reimplement the compilation or rendering logic.

License

MIT