A simple transformer of text in YFM (Yandex Flavored Markdown) to HTML
npm install @diplodoc/transformрусский | english
---
@diplodoc/transform — пакет для трансформации Yandex Flavored Markdown в HTML.
Используйте его в своем коде для работы с текстом во время выполнения программы. Например, чтобы отображать пользовательский контент.
1. Установите пакет:
``shell`
npm i @diplodoc/transform
1. Подключите пакет в своем коде, используя функцию require() или import():
`javascript`
const transform = require('@diplodoc/transform');
1. Для корректного отображения подключите в проект CSS-стили и клиентские скрипты:
`css`
@import '~@diplodoc/transform/dist/css/yfm.css';
`javascript`
import '@diplodoc/transform/dist/js/yfm';
Пакет предоставляет функцию transform():
- входные данные — строка с YFM и настройки;
- возвращаемое значение — объект с полями result и logs.
result — объект результата, содержит поля:
- html — строка с HTML.meta
- — метаданные из переданного контента.title
- — заголовок документа. Возвращается, если заданы настройки extractTitle = true или needTitle = true.headings
- — список заголовков документа.
logs — информация о процессе трансформации, включает массивы:
- error — ошибки.warn
- — предупреждения.info
- — дополнительная информация.
`javascript
const fs = require('fs');
const transform = require('@diplodoc/transform');
const content = fs.readFileSync(filePath, 'utf');
const vars = {user: {name: 'Alice'}};
const {
result: {html, meta, title, headings},
logs,
} = transform(content, {vars});
`
Вы можете заменить стандартный HTML-санитайзер своей собственной реализацией, передав функцию sanitize в опциях:
`javascript
const customSanitizer = (html, options) => {
// Ваша логика санитизации
return sanitizedHtml;
};
const {result} = transform(content, {
sanitize: customSanitizer,
// Другие опции...
});
`
Это полезно, когда вам нужно реализовать специфические правила санитизации или интегрироваться с другой библиотекой санитизации. Функция санитайзера должна принимать HTML-строку в качестве входных данных и возвращать санитизированный HTML.
MIT
common
- --yfm-color-text
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
code
- --yfm-color-inline-code
-
-
-
hightlight
- --yfm-color-hljs-background
-
-
-
-
-
-
-
-
-
note
- --yfm-color-note-tip
-
-
-
-
-
-
term
- --yfm-color-term-title
-
-
-
-
modal
- --yfm-color-modal-content
-
-
-
file
- --yfm-file-icon
-
list
- --yfm-list-item-margin-block
-
-
-
В пакете представлены unit-тесты на базе Jest и визуальные e2e-тесты на базе Playwright. Playwright-тесты
расположены в подпакете e2e.
#### Playwright: prerequisites
Для того, чтобы обеспечить минимальное количество внешних факторов, которые могут повлиять на выполнение e2e-тестов, рекомендуется запускать локально Playwright-тесты в Docker-контейнере с помощью скрипта пакета test:playwright.
Этот скрипт настроит необходимое окружение в Docker и установит все зависимости для него.
`sh`
$ npm run test:playwright
Подразумевается, что у вас установлен Docker CLI и Docker Engine.
Для того, чтобы использовать UI-режим Playwright, используйте скрипт playwright:docker:ui (в подпакете e2e):
`sh`
$ cd e2e
$ npm run playwright:docker:ui
##### Пользователям macOS: не хотите/не имеете возможность использовать Docker Desktop?
Благодаря относительно недавним изменениям лицензии, использование Docker Desktop в коммерческих условиях
больше не является бесплатным. Используйте Lima или одну из обёрток, таких как Colima или Rancher Desktop.
Если при настройке вы выбрали имя инстанса не docker, можете передать нужное с помощью переменной LIMA_INSTANCE при обращении к скрипту playwright:docker/test:playwright:
`sh`
$ LIMA_INSTANCE=instancename npm run test:playwright
Эта информация необходима скрипту, чтобы корректно настроить переменную окружения DOCKER_HOST`.