Skip to content

Docs and Markdown integrations

Write a code block with the language fluxygram in your Markdown and it becomes an animated diagram. No HTML, no imports in the page. This page uses it:

Put the diagram JSON inside, or point to a file with src:

```fluxygram
{ "type": "flow", "nodes": [...], "edges": [...], "steps": [...] }
```
```fluxygram src="/diagrams/checkout.flux.json"
```

After the language you can add the same attributes as the component: theme=light, autoplay=false, controls=false, lang=es, and for live status mode=tracker stage=shipped.

```fluxygram theme=light autoplay=false
Terminal window
npm install @fluxygram/astro
astro.config.mjs
import { defineConfig } from 'astro/config';
import fluxygram from '@fluxygram/astro';
export default defineConfig({
integrations: [fluxygram()], // with Starlight: [fluxygram(), starlight({ ... })]
});

It works in .md and .mdx, and loads the component on every page, so you can also write <fluxy-gram> by hand.

Any other Markdown tool built on markdown-it takes markdownItFluxygram. For a plain HTML page, add the CDN script and write the tag.