ondine README

项目的 README,来自 github.com/wevm/ondine。合并为一个 markdown 文件:README.md。

Ondine

Mermaid diagrams, compiled with Rust

Overview · Agent Prompt · Philosophy · Features · Documentation · Guides · API Reference

Overview

Sequence diagram rendered by Ondine
sequenceDiagram
  participant Browser
  participant Server
  participant Database
  Browser->>Server: GET /orders
  Server->>Database: SELECT * FROM orders
  Database-->>Server: rows
  alt cached
    Server-->>Browser: 304 Not Modified
  else fresh
    Server-->>Browser: 200 OK
  end

Agent Prompt

Paste this prompt into a coding agent:

Read github.com/wevm/ondine and help me render my Mermaid diagrams with Ondine.

Philosophy

Features

Documentation

Head to the documentation to get started and learn more about Ondine.

License

MIT

ondine (wevm/ondine)

正在搜索数据库…

451 ·GitHub
这是什么?Ondine 会提前把 Mermaid 语法的图表编译成静态 SVG,因此你的页面只需加载普通的 SVG,无需像 Mermaid.js 这样的 JS 渲染库。
它是单个 CLI 工具,还是需要导入的库?它是一套小型工具包:包括 CLI(ondine 命令)、用于导入 .mmd 文件的 Vite 插件、Node 编译器模块,以及可选启用的浏览器端 WASM 编译器,覆盖多种不同的使用方式。
如何在项目中开始使用?添加 Vite 插件即可直接导入 .mmd 文件;对文件或标准输入运行 ondine CLI;或在 Node 脚本中导入 ondine/compiler。文档中详细介绍了每种方式。
我需要重写现有的 Mermaid 图表吗?不需要。每种图表都接受与 Mermaid 相同的输入语法,因此现有的 .mmd 文件无需任何修改即可与 Ondine 一起使用。
默认是否包含浏览器端编译?不包含,浏览器端编译需要主动开启:你必须显式加载 ondine/compiler/wasm 模块,可以按图表类型逐个加载,也可以全部加载,因为常规工作流是在构建前完成编译的。
我能直接在 GitHub 的 README 文件中嵌入 Ondine 图表吗?可以。图片 Worker 会渲染编码在 URL 中的图表,因此编译好的 SVG 图表无需构建步骤,就能直接嵌入 GitHub README 文件中。
不重新编译就能更改图表样式吗?可以。Ondine 提供以 --ondine- 为前缀的 CSS 自定义属性,可即时切换配色方案,无需重新编译。
显示图表所需的运行时有多小?gzip 压缩后仅 210 字节。mount() 函数直接插入预编译的 SVG,无需下载任何解析器或布局引擎。
Ondine 可以免费使用吗?可以,它采用 MIT 许可证发布。
有哪些类似的项目?tsrs, oxc, marked, lollipop-css, liteparse, rollup, mitex, english-rs
作者
wevm
大小
62.2 MB
星标
451
更新
提交Nov 11
时长
1个月
提交 · 90 天