pele README

README проекта с github.com/obsidianmd/pele. Одним файлом markdown: README.md.

Pele

Pele renders Mermaid diagrams to SVG. It is small, synchronous, has no runtime dependencies, and uses CSS variables for colors and fonts.

Pele supports every diagram type built into Mermaid 12.1.0.

Documentation, examples, and a playground are at pele.run.

Install

npm install pele

Or load it from a CDN:

<script src="https://cdn.jsdelivr.net/npm/pele@1/dist/pele.global.js"></script>
<script>
  for (const el of document.querySelectorAll('pre.mermaid')) pele.mount(el, el.textContent);
</script>

Use

import { render } from 'pele';

const { svg } = render(`flowchart LR
  A[Mermaid text] --> B[SVG]`);

document.querySelector('#diagram').innerHTML = svg;

In a browser, mount() renders into an element, reads fonts from CSS, and adapts the layout to the container width:

import { mount } from 'pele';

mount(document.querySelector('#diagram'), text);

See the API for options and error handling.

The main entry point includes every diagram type. Reduce the initial bundle size by registering individual types or loading them on demand:

import { register, render } from 'pele/core';
import flowchart from 'pele/diagrams/flowchart';

register(flowchart);
import { renderAsync } from 'pele/lazy';

const { svg } = await renderAsync(text);

Theme

Set CSS variables on the diagram or a parent element to customize colors and fonts:

.pele {
  --pele-bg: #fffcf0;
  --pele-fg: #100f0f;
  --pele-muted: #6f6e69;
  --pele-line: #100f0f;
  --pele-surface: #f2f0e5;
  --pele-surface-alt: #e6e4d9;
  --pele-border: #cecdc3;
  --pele-accent: #205ea6;
  --pele-font: sans-serif;
  --pele-radius: 4px;
}

Charts use --pele-series-1 through --pele-series-8. Colors adapt to theme changes without being re-rendered. See Theming for all variables, fonts, and class names.

Security

Pele escapes diagram text, filters links and styles, and limits source and output size. See Security for handling untrusted diagrams, displaying errors, and supplying icons.

Compatibility

Pele targets Mermaid 12.1.0 syntax, with its own layout and visual style. Its parsers are tested against Mermaid's parser specs and with differential fuzzing.

Develop

npm install
npm test
npm run build
npm run bench

npm run bench:mermaid times Pele and Mermaid.js in headless Chrome on the same diagrams and compares bundle sizes. It needs Node 22 or later. It fetches Mermaid 12.1.0 from unpkg; pass -- --mermaid <version> for another release, and set CHROME if Chrome is not in /Applications.

The documentation site and playground are in website/ and use Node 24 and pnpm 12. With nvm:

cd website
nvm use
pnpm install
pnpm dev

After installing the website dependencies, run npm run test:website from the repository root to check the playground.

See Contributing for parser testing.

License

MIT. The specs under tests/compat and the grammar files beside them come from Mermaid, which is also MIT licensed.

pele (obsidianmd/pele)

Ищем в базе…

4.6K ·GitHub
Что это такое?Pele — это легковесная библиотека, которая отрисовывает диаграммы Mermaid в SVG. Она создана для скорости и не имеет зависимостей во время выполнения.
Это полноценная библиотека для графиков или только отрисовщик Mermaid?Это специализированный отрисовщик Mermaid, а не общая библиотека для графиков: он преобразует синтаксис диаграмм Mermaid в SVG и поддерживает все типы диаграмм, встроенные в Mermaid 12.1.0.
Как подключить это к проекту?Установите как пакет или загрузите напрямую из CDN, а затем вызовите mount() в браузере, чтобы отрисовать диаграмму в элементе.
Нужно ли установить Mermaid.js для работы?Нет. Pele включает собственные парсеры и не имеет зависимостей во время выполнения, поэтому он не опирается на саму библиотеку Mermaid.js, а только на совместимый синтаксис Mermaid.
Поддерживаются ли все типы диаграмм Mermaid?Да, основная точка входа охватывает все типы диаграмм Mermaid 12.1.0. При этом можно регистрировать отдельные типы или загружать их по требованию, чтобы уменьшить размер сборки.
Безопасно ли отрисовывать диаграммы из ненадёжного пользовательского ввода?Pele экранирует текст диаграмм, фильтрует ссылки и стили и ограничивает размер исходника и результата. Всё это специально направлено на то, чтобы отрисовка ненадёжных диаграмм была безопаснее.
Как настроить цвета и шрифты диаграмм?Задайте CSS-переменные для элемента диаграммы или родительского контейнера. Для серий графиков используются --pele-series-1 через --pele-series-8, а цвета обновляются сразу, без повторной отрисовки.
Почему стоит выбрать Pele, а не собственный отрисовщик Mermaid?Pele — это небольшой, синхронный отрисовщик SVG без зависимостей, ориентированный на скорость. Его парсеры проверены по спецификациям парсера самого Mermaid, а для совместимости дополнительно применяется дифференциальное фаззинг-тестирование.
Можно ли уменьшить размер сборки, если нужны только несколько типов диаграмм?Да. Вместо импорта полной точки входа можно зарегистрировать только нужные типы диаграмм или загружать дополнительные типы по требованию.
Какие есть похожие проекты?beautiful-mermaid, diagram-design, plotly.js, charts, echarts, d3, cesium, graph
Автор
obsidianmd
Размер
2.9 MB
Звёзды
4.6K
Возраст
1 мес
Коммиты · 90 дней