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, а не JS-библиотеку для отрисовки, такую как Mermaid.js.
Это один CLI-инструмент или библиотека, которую я импортирую?Это небольшой набор инструментов: CLI (команда ondine), плагин для Vite для импорта файлов .mmd, модуль компилятора для Node и компилятор в браузере на WASM, который включается по желанию. Они покрывают разные способы использования.
Как начать использовать это в проекте?Добавьте плагин для Vite, чтобы импортировать файлы .mmd напрямую, запускайте CLI ondine для файлов или stdin, либо импортируйте ondine/compiler в скрипте на Node. В документации подробно описан каждый из этих способов.
Нужно ли переписывать мои существующие диаграммы Mermaid?Нет, каждая диаграмма принимает тот же входной синтаксис, что и Mermaid, поэтому существующие файлы .mmd работают с Ondine без изменений.
Компиляция в браузере включена по умолчанию?Нет, компиляция в браузере включается по желанию: нужно явно загрузить модули ondine/compiler/wasm, либо по одному на каждый тип диаграмм, либо все сразу, так как обычный процесс компилирует диаграммы заранее, во время сборки.
Можно ли встраивать диаграммы Ondine прямо в README на GitHub?Да, Worker для изображений отрисовывает диаграммы, закодированные в URL, поэтому скомпилированные SVG-диаграммы можно вставлять прямо в README на GitHub без этапа сборки.
Можно ли изменить стиль диаграмм без их перекомпиляции?Да, Ondine предоставляет пользовательские свойства CSS с префиксом --ondine-, которые на лету переключают цветовые схемы без необходимости в перекомпиляции.
Насколько мал рантайм, необходимый для отображения диаграмм?Всего 210 байт в сжатом виде gzip: функция mount() вставляет предварительно скомпилированный SVG, не загружая никакого парсера или движка раскладки.
Можно ли пользоваться Ondine бесплатно?Да, он выпущен под лицензией MIT.
Какие есть похожие проекты?tsrs, oxc, marked, lollipop-css, liteparse, rollup, mitex, english-rs
Автор
wevm
Размер
62.2 MB
Звёзды
451
Обновлён
КоммитNov 11
Возраст
1 мес
Коммиты · 90 дней