Getting started
Usage
Add comark-flint-chart to parseMarkdown for static docs, or pair it with the shipped Vue Flint renderer.
Parse for static docs
parse.ts
import { parseMarkdown } from 'comark'
import flint from 'comark-flint-chart'
const tree = await parseMarkdown(content, {
plugins: [flint({ flint: { output: 'svg' } })],
})
With output: 'component' (default) and no framework renderer, the AST still contains <Flint> nodes — register a renderer (or use the shipped Vue one) to display them.
Use with the Vue renderer (recommended)
App.vue
<script setup lang="ts">
import { Markdown } from '@comark/vue'
import flint, { Flint } from 'comark-flint-chart/vue'
</script>
<template>
<Suspense>
<Markdown :plugins="[flint()]" :components="{ Flint }">
{{ markdown }}
</Markdown>
</Suspense>
</template>
Author a chart in markdown
chart.md
```flint backend="vegalite" theme="economist"
{
"data": { "values": [{ "month": "Jan", "revenue": 120000 }] },
"semantic_types": { "month": "Time", "revenue": "Money" },
"chart_spec": {
"chartType": "Bar Chart",
"encodings": {
"x": { "field": "month" },
"y": { "field": "revenue" }
},
"baseSize": { "width": 560, "height": 320 }
}
}
```
Or use a directive with a bound spec — see Dual syntax.
Set plugin defaults
plugins.ts
import flint from 'comark-flint-chart'
const plugins = [
flint({
flint: {
backend: 'vegalite',
theme: 'economist',
output: 'component',
width: 560,
height: 320,
},
}),
]
Frontmatter overrides factory defaults.