Repolode
obsidianmd

obsidianmd/pele

Небольшой синхронный рендерер, преобразующий текст диаграмм Mermaid в SVG без runtime-зависимостей.

Звёзды
2,476
Форки
74
Открытые issues
23
Последний коммит
11 часов назад

Что это?

Pele преобразует исходный код диаграмм Mermaid в SVG. Он поддерживает синтаксис Mermaid 12.1.0 и все типы диаграмм, встроенные в эту версию, используя собственные алгоритм раскладки и визуальный стиль.

Рендеринг выполняется синхронно и не требует runtime-зависимостей. Цвета и шрифты задаются через CSS-переменные, поэтому диаграмма может подстраиваться под тему страницы и обновляться при её смене без повторного рендеринга. В браузере вспомогательная функция монтирования отображает диаграмму в элементе, считывает шрифты из CSS и адаптирует раскладку к ширине контейнера. Основная точка входа включает все типы диаграмм, но отдельные типы можно регистрировать или загружать по требованию, чтобы уменьшить размер бандла.

Проект экранирует текст диаграмм, фильтрует ссылки и стили, а также ограничивает размер входных и выходных данных; в документации есть рекомендации по обработке диаграмм из ненадёжных источников. Проект распространяется через npm, а также доступен для загрузки с CDN в виде глобального скрипта.

Ключевые возможности

  • 01Рендерит в SVG все типы диаграмм, встроенные в Mermaid 12.1.0.
  • 02Не имеет runtime-зависимостей и выполняет рендеринг синхронно.
  • 03Задаёт цвета и шрифты через CSS-переменные, которые обновляются при смене темы.
  • 04Предоставляет вспомогательную функцию монтирования в браузере, адаптирующую раскладку к ширине контейнера.
  • 05Поддерживает загрузку отдельных типов диаграмм по требованию, чтобы уменьшить размер бандла.
  • 06Экранирует текст и фильтрует ссылки и стили при обработке ненадёжных данных.

Сценарии использования

  • Рендеринг диаграмм Mermaid на веб-странице или сайте документации без тяжёлой зависимости.
  • Встраивание диаграмм, которые должны подстраиваться под светлую или тёмную тему сайта через CSS.
  • Создание SVG-диаграмм из текста Mermaid на сервере или в инструментах сборки.
  • Уменьшение объёма JavaScript за счёт загрузки только тех типов диаграмм, которые используются на странице.

Быстрый старт

  1. 1

    Установите пакет

    npm install pele
  2. 2

    Импортируйте render и преобразуйте текст Mermaid в SVG

Что важно знать

  • В README лицензия не указана; в метаданных указано NOASSERTION, хотя в README упоминается MIT.
  • Pele ориентирован на синтаксис Mermaid 12.1.0 и использует собственную компоновку и визуальный стиль, поэтому результат может отличаться от Mermaid.

Темы

Частые вопросы

Что такое pele?
Небольшой синхронный рендерер, преобразующий текст диаграмм Mermaid в SVG без runtime-зависимостей. Pele преобразует исходный код диаграмм Mermaid в SVG. Он поддерживает синтаксис Mermaid 12.1.0 и все типы диаграмм, встроенные в эту версию, используя собственные алгоритм раскладки и визуальный стиль.
pele можно использовать бесплатно? Какая у него лицензия?
pele распространяется с открытым исходным кодом под лицензией Other. Перед использованием в коммерческих продуктах проверьте условия лицензии.
pele всё ещё поддерживается?
Активно поддерживается. Последний коммит в pele — 19 окт. 2026 г..
Для чего можно использовать pele?
Рендеринг диаграмм Mermaid на веб-странице или сайте документации без тяжёлой зависимости. Встраивание диаграмм, которые должны подстраиваться под светлую или тёмную тему сайта через CSS. Создание SVG-диаграмм из текста Mermaid на сервере или в инструментах сборки. Уменьшение объёма JavaScript за счёт загрузки только тех типов диаграмм, которые используются на странице.
Как установить pele?
Установите пакет: npm install pele Импортируйте render и преобразуйте текст Mermaid в SVG
Где скачать pele?
Исходный код и инструкции по установке — на GitHub: https://github.com/obsidianmd/pele

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты

Навык для агентских инструментов, который создаёт редакционные диаграммы в одном автономном HTML-файле с SVG и поддерживает 45 типов диаграмм и оформление в стиле бренда.

58,1 тыс.3,7 тыс.HTMLMITОбновлён 3 дня назад