wevm/ondine

选用指南

AI 根据 README 整理 · 2026/10/21 13:21:39

使用方式

可通过 Vite 插件在构建时编译 .mmd 文件，或使用 CLI 命令从文件或标准输入编译图表，也可在 Node 脚本或服务器中使用编译器，或通过 Markdown/MDX 插件替换代码块。

查看 README 依据

- **Compiled.** Diagrams compile ahead of time, so pages ship SVG instead of a renderer. - **Compatible.** Every diagram accepts the same input as Mermaid. - **Precise.** Square outlines and rounded orthogonal edges. - **Small.** A 210-byte runtime (gzip) mounts precompiled diagrams. ## Features - [**Vite Plugin**](site/src/content/docs/guides/vite.mdx): `.mmd` imports compiled to SVG at build time. - [**CLI**](site/src/content/docs/guides/cli.mdx): the `ondine` command compiles diagrams from files or standard input.

- [**Node Compiler**](site/src/content/docs/guides/node.mdx): `ondine/compiler` renders source to SVG in scripts and servers. - [**Markdown and MDX**](site/src/content/docs/api/remark.mdx): `ondine/remark` replaces ` ```mermaid ` fences with compiled SVG. - [**In-Browser Compilation**](site/src/content/docs/guides/browser.mdx): opt-in `ondine/compiler/wasm` modules, one per diagram type or `all`. - [**GitHub Images**](site/src/content/docs/guides/github.mdx): an image Worker renders diagrams encoded in a URL for READMEs.

部署要求

需要 Node.js 环境以使用 Node 编译器或相关插件，浏览器内编译需使用 WASM 模块。

查看 README 依据

- [**Node Compiler**](site/src/content/docs/guides/node.mdx): `ondine/compiler` renders source to SVG in scripts and servers. - [**Markdown and MDX**](site/src/content/docs/api/remark.mdx): `ondine/remark` replaces ` ```mermaid ` fences with compiled SVG. - [**In-Browser Compilation**](site/src/content/docs/guides/browser.mdx): opt-in `ondine/compiler/wasm` modules, one per diagram type or `all`. - [**GitHub Images**](site/src/content/docs/guides/github.mdx): an image Worker renders diagrams encoded in a URL for READMEs.

已知限制

图表需预先编译，页面加载时仅需挂载预编译的 SVG，无需下载解析器或布局代码。

查看 README 依据

- [**Theming**](site/src/content/docs/guides/theming.mdx): `--ondine-*` CSS custom properties switch schemes without compiling again. - [**Mounting**](site/src/content/docs/guides/mounting.mdx): `mount` inserts precompiled SVG without downloading a parser or layout code. ## Documentation Head to the [documentation](https://ondine.sh) to get started and learn more about Ondine. ## License [MIT](LICENSE)