Integraciones con docs y Markdown
Escribe un bloque de código con el lenguaje fluxygram en tu Markdown y se vuelve un diagrama animado. Sin HTML ni imports en la página. Esta página lo usa:
El bloque de código
Sección titulada «El bloque de código»Pon el JSON del diagrama adentro, o apunta a un archivo con src:
```fluxygram{ "type": "flow", "nodes": [...], "edges": [...], "steps": [...] }```
```fluxygram src="/diagramas/compra.flux.json"```Después del lenguaje puedes poner los mismos atributos del componente: theme=light, autoplay=false, controls=false, lang=es y, para el estado en vivo, mode=tracker stage=shipped.
```fluxygram theme=light autoplay=falseConfigúralo
Sección titulada «Configúralo»npm install @fluxygram/astroimport { defineConfig } from 'astro/config';import fluxygram from '@fluxygram/astro';
export default defineConfig({ integrations: [fluxygram()], // con Starlight: [fluxygram(), starlight({ ... })]});Funciona en .md y .mdx, y carga el componente en todas las páginas, así que también puedes escribir <fluxy-gram> a mano.
npm install @fluxygram/docusaurus @fluxygram/markdownimport { remarkFluxygram } from '@fluxygram/markdown';
export default { plugins: ['@fluxygram/docusaurus'], presets: [ [ 'classic', { docs: { remarkPlugins: [remarkFluxygram] }, blog: { remarkPlugins: [remarkFluxygram] }, }, ], ],};El plugin carga el componente en el navegador; el plugin de remark convierte los bloques de código en diagramas.
npm install @fluxygram/markdown @fluxygram/elementimport { defineConfig } from 'vitepress';import { markdownItFluxygram } from '@fluxygram/markdown';
export default defineConfig({ markdown: { config: (md) => md.use(markdownItFluxygram) }, vue: { template: { compilerOptions: { isCustomElement: (tag) => tag === 'fluxy-gram' } } },});import DefaultTheme from 'vitepress/theme';
export default { extends: DefaultTheme, enhanceApp() { if (!import.meta.env.SSR) import('@fluxygram/element'); },};Cualquier herramienta basada en remark (Next.js con @next/mdx, Nextra, Gatsby, unified directo) acepta el plugin de remark:
npm install @fluxygram/markdown @fluxygram/elementimport createMDX from '@next/mdx';import { remarkFluxygram } from '@fluxygram/markdown';
const withMDX = createMDX({ options: { remarkPlugins: [remarkFluxygram] } });export default withMDX({ pageExtensions: ['js', 'jsx', 'md', 'mdx', 'ts', 'tsx'] });Luego carga el componente una vez en el cliente, por ejemplo en un layout: useEffect(() => { import('@fluxygram/element'); }, []).
El plugin de Fluxygram para Obsidian va en camino a los plugins de la comunidad. Convierte los mismos bloques fluxygram en diagramas dentro de tus notas y sigue el tema claro u oscuro de Obsidian.
Cualquier otra
Sección titulada «Cualquier otra»Cualquier otra herramienta de Markdown basada en markdown-it acepta markdownItFluxygram. Para una página HTML simple, agrega el script del CDN y escribe la etiqueta.