@diplodoc/transform v4.34.0
русский | english
@diplodoc/transform — пакет для трансформации Yandex Flavored Markdown в HTML.
Используйте его в своем коде для работы с текстом во время выполнения программы. Например, чтобы отображать пользовательский контент.
Установка {#install}
Установите пакет:
npm i @diplodoc/transform
Подключите пакет в своем коде, используя функцию
require()
илиimport()
:const transform = require('@diplodoc/transform');
Для корректного отображения подключите в проект CSS-стили и клиентские скрипты:
@import '~@diplodoc/transform/dist/css/yfm.css';
import '@diplodoc/transform/dist/js/yfm';
Использование {#use}
Пакет предоставляет функцию transform()
:
- входные данные — строка с YFM и настройки;
- возвращаемое значение — объект с полями
result
иlogs
.
Поле result
result
— объект результата, содержит поля:
html
— строка с HTML.meta
— метаданные из переданного контента.title
— заголовок документа. Возвращается, если заданы настройкиextractTitle = true
илиneedTitle = true
.headings
— список заголовков документа.
Поле logs
logs
— информация о процессе трансформации, включает массивы:
error
— ошибки.warn
— предупреждения.info
— дополнительная информация.
Пример вызова функции
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});
License
MIT
8 months ago
8 months ago
8 months ago
9 months ago
9 months ago
10 months ago
10 months ago
1 year ago
10 months ago
12 months ago
11 months ago
12 months ago
11 months ago
12 months ago
11 months ago
12 months ago
10 months ago
12 months ago
11 months ago
12 months ago
11 months ago
12 months ago
11 months ago
12 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
12 months ago
1 year ago
11 months ago
11 months ago
10 months ago
11 months ago
9 months ago
10 months ago
10 months ago
9 months ago
9 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago