{"_id":"@belym.a.2105/yfm-transform","_rev":"1-60b84cfa236030dbb3ee78d059e385a6","name":"@belym.a.2105/yfm-transform","dist-tags":{"latest":"4.29.0"},"versions":{"4.28.2":{"name":"@belym.a.2105/yfm-transform","version":"4.28.2","keywords":["markdown","yandex","docs","yfm","documentation","tool","tools","generator"],"author":{"name":"YFM Team","email":"yfm-team@yandex.ru"},"license":"MIT","_id":"@belym.a.2105/yfm-transform@4.28.2","maintainers":[{"name":"belym.a.2105","email":"belym.a.2105@gmail.com"}],"contributors":[{"name":"The following authors have created the source code of \"Yandex Flavored Markdown\""},{"name":"published and distributed by YANDEX LLC as the owner:"},{"name":"Evgeny Uspenskiy euspenskiy@yandex-team.ru"},{"name":"Andrey Morozov amje@yandex-team.ru"},{"name":"David Nanyan dave@yandex-team.ru"},{"name":"Timur Sufiev tsufiev@yandex-team.ru"},{"name":"Igor Vernichenko igorvern@yandex-team.ru"},{"name":"Vladislav Kharitonov vladvlad@yandex-team.ru"},{"name":"Aleksandr Sinyatkin daff@yandex-team.ru"},{"name":"Mikhail Kharin lunatic174@yandex-team.ru"},{"name":"Evgeny Biriulin birman111@yandex-team.ru"},{"name":"Alexey Sizikov w100@yandex-team.ru"}],"homepage":"https://github.com/diplodoc-platform/transform#readme","bugs":{"url":"https://github.com/diplodoc-platform/transform/issues"},"dist":{"shasum":"1e233b0ad366e11a3f4874afdbadc0741e69476b","tarball":"https://registry.npmjs.org/@belym.a.2105/yfm-transform/-/yfm-transform-4.28.2.tgz","fileCount":381,"integrity":"sha512-t/3t3X4F3XVCZf8fjTZgsXQUPceFstQSc1kkxLfJ2ya2TKx86mu5kEwWhst1cEBKw7D2gQBMCEFo8DKHSQS3Vw==","signatures":[{"sig":"MEQCIAPKjgyt+28MrzbuaP+i+PN8YeZ5KyFck3e663uf+aVIAiByyOFJhQam8t6y6B7edASL1bUAqhunrvRwEQCopBymEQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1072008},"main":"lib/index.js","types":"./lib/index.d.ts","gitHead":"4e1bb4a623f9a2728f1203f74965803526e19949","scripts":{"lint":"eslint --max-warnings=0 \"{src,test}/**/*.{js,jsx,ts,tsx}\"","test":"jest --coverage","build":"npm run build:lib && npm run build:dist","lint:fix":"eslint --fix --max-warnings=0 \"{src,test}/**/*.{js,jsx,ts,tsx}\"","build:lib":"tsc -p tsconfig.transform.json","precommit":"npm run lint && npm run test","typecheck":"tsc -p tsconfig.json --noEmit","build:dist":"./esbuild/build.js","prepublishOnly":"npm run build"},"_npmUser":{"name":"belym.a.2105","email":"belym.a.2105@gmail.com"},"repository":{"url":"git+ssh://git@github.com/diplodoc-platform/transform.git","type":"git"},"_npmVersion":"10.7.0","description":"A simple transformer of text in YFM (Yandex Flavored Markdown) to HTML","directories":{},"_nodeVersion":"20.14.0","dependencies":{"css":"^3.0.0","svgo":"^3.2.0","chalk":"^4.1.2","lodash":"4.17.21","cheerio":"^1.0.0-rc.12","js-yaml":"^4.1.0","slugify":"1.6.5","cssfilter":"0.0.10","markdown-it":"^13.0.2","markdownlint":"^0.32.1","sanitize-html":"^2.11.0","github-slugger":"^1.5.0","markdown-it-sup":"1.0.0","markdown-it-meta":"0.0.1","markdown-it-attrs":"4.1.4","markdown-it-deflist":"2.1.0","get-root-node-polyfill":"1.0.0","@diplodoc/tabs-extension":"^3.3.0","markdownlint-rule-helpers":"0.17.2"},"_hasShrinkwrap":false,"devDependencies":{"jest":"28.1.3","esbuild":"^0.19.2","postcss":"^8.4.27","ts-jest":"28.0.8","@types/css":"0.0.34","typescript":"4.7.4","@types/jest":"28.1.7","@types/node":"17.0.10","autoprefixer":"^10.4.15","highlight.js":"^11.8.0","@types/lodash":"4.14.183","@types/js-yaml":"^4.0.5","@diplodoc/tsconfig":"^1.0.2","@types/markdown-it":"12.2.3","postcss-preset-env":"^9.1.1","esbuild-sass-plugin":"^2.12.0","markdown-it-testgen":"^0.1.6","@types/sanitize-html":"^2.9.3","@types/github-slugger":"^1.3.0","@diplodoc/babel-preset":"^1.0.2","@diplodoc/eslint-config":"^2.0.0","@types/markdown-it-attrs":"4.1.0","@diplodoc/prettier-config":"^2.0.0"},"peerDependencies":{"highlight.js":"^10.0.3 || ^11"},"moduleDirectories":["node_modules","src"],"peerDependenciesMeta":{"highlight.js":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/yfm-transform_4.28.2_1724614071779_0.5269475759685196","host":"s3://npm-registry-packages"}},"4.29.0":{"name":"@belym.a.2105/yfm-transform","version":"4.29.0","description":"A simple transformer of text in YFM (Yandex Flavored Markdown) to HTML","keywords":["markdown","yandex","docs","yfm","documentation","tool","tools","generator"],"homepage":"https://github.com/diplodoc-platform/transform#readme","bugs":{"url":"https://github.com/diplodoc-platform/transform/issues"},"repository":{"type":"git","url":"git+ssh://git@github.com/diplodoc-platform/transform.git"},"license":"MIT","author":{"name":"YFM Team","email":"yfm-team@yandex.ru"},"main":"lib/index.js","scripts":{"build":"npm run build:lib && npm run build:dist","build:dist":"./esbuild/build.js","build:lib":"tsc -p tsconfig.transform.json","lint":"eslint --max-warnings=0 \"{src,test}/**/*.{js,jsx,ts,tsx}\"","lint:fix":"eslint --fix --max-warnings=0 \"{src,test}/**/*.{js,jsx,ts,tsx}\"","precommit":"npm run lint && npm run test","prepublishOnly":"npm run build","test":"jest --coverage","typecheck":"tsc -p tsconfig.json --noEmit"},"dependencies":{"@diplodoc/tabs-extension":"^3.3.0","chalk":"^4.1.2","cheerio":"^1.0.0-rc.12","css":"^3.0.0","cssfilter":"0.0.10","get-root-node-polyfill":"1.0.0","github-slugger":"^1.5.0","js-yaml":"^4.1.0","lodash":"4.17.21","markdown-it":"^13.0.2","markdown-it-attrs":"4.1.4","markdown-it-deflist":"2.1.0","markdown-it-meta":"0.0.1","markdown-it-sup":"1.0.0","markdownlint":"^0.32.1","markdownlint-rule-helpers":"0.17.2","sanitize-html":"^2.11.0","slugify":"1.6.5","svgo":"^3.2.0"},"devDependencies":{"@diplodoc/babel-preset":"^1.0.2","@diplodoc/eslint-config":"^2.0.0","@diplodoc/prettier-config":"^2.0.0","@diplodoc/tsconfig":"^1.0.2","@types/css":"0.0.34","@types/github-slugger":"^1.3.0","@types/jest":"28.1.7","@types/js-yaml":"^4.0.5","@types/lodash":"4.14.183","@types/markdown-it":"12.2.3","@types/markdown-it-attrs":"4.1.0","@types/node":"17.0.10","@types/sanitize-html":"^2.9.3","autoprefixer":"^10.4.15","esbuild":"^0.19.2","esbuild-sass-plugin":"^2.12.0","highlight.js":"^11.8.0","jest":"28.1.3","markdown-it-testgen":"^0.1.6","postcss":"^8.4.27","postcss-preset-env":"^9.1.1","ts-jest":"28.0.8","typescript":"4.7.4"},"peerDependencies":{"highlight.js":"^10.0.3 || ^11"},"peerDependenciesMeta":{"highlight.js":{"optional":true}},"moduleDirectories":["node_modules","src"],"_id":"@belym.a.2105/yfm-transform@4.29.0","contributors":[{"name":"The following authors have created the source code of \"Yandex Flavored Markdown\""},{"name":"published and distributed by YANDEX LLC as the owner:"},{"name":"Evgeny Uspenskiy euspenskiy@yandex-team.ru"},{"name":"Andrey Morozov amje@yandex-team.ru"},{"name":"David Nanyan dave@yandex-team.ru"},{"name":"Timur Sufiev tsufiev@yandex-team.ru"},{"name":"Igor Vernichenko igorvern@yandex-team.ru"},{"name":"Vladislav Kharitonov vladvlad@yandex-team.ru"},{"name":"Aleksandr Sinyatkin daff@yandex-team.ru"},{"name":"Mikhail Kharin lunatic174@yandex-team.ru"},{"name":"Evgeny Biriulin birman111@yandex-team.ru"},{"name":"Alexey Sizikov w100@yandex-team.ru"}],"gitHead":"dff39d56a5721c6fc7edd8fa2597695339f02010","types":"./lib/index.d.ts","_nodeVersion":"20.14.0","_npmVersion":"10.7.0","dist":{"integrity":"sha512-lHOvNeQQkLVCwmyDZtl7wkX+J6wW0mMeEd20Gg/AsoIjFCnIx4J0iDoSUJZD0pQ7pQNEzohQodlTxwniQpdyzw==","shasum":"0f188d96c8033fcc775b8478a8711ec901253d34","tarball":"https://registry.npmjs.org/@belym.a.2105/yfm-transform/-/yfm-transform-4.29.0.tgz","fileCount":381,"unpackedSize":1072381,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFpja+26oldQzrQmk+2b7sXp8g7i0+xxYs6gFZVtSuszAiAQFuZe6OS4EskYaYaBsUoQHL/q9yv6dQE+4Cy8hSwarA=="}]},"_npmUser":{"name":"belym.a.2105","email":"belym.a.2105@gmail.com"},"directories":{},"maintainers":[{"name":"belym.a.2105","email":"belym.a.2105@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/yfm-transform_4.29.0_1724615576867_0.4853794474300386"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-25T19:27:51.692Z","modified":"2024-08-25T19:52:57.211Z","4.28.2":"2024-08-25T19:27:52.036Z","4.29.0":"2024-08-25T19:52:57.036Z"},"bugs":{"url":"https://github.com/diplodoc-platform/transform/issues"},"author":{"name":"YFM Team","email":"yfm-team@yandex.ru"},"license":"MIT","homepage":"https://github.com/diplodoc-platform/transform#readme","keywords":["markdown","yandex","docs","yfm","documentation","tool","tools","generator"],"repository":{"type":"git","url":"git+ssh://git@github.com/diplodoc-platform/transform.git"},"description":"A simple transformer of text in YFM (Yandex Flavored Markdown) to HTML","contributors":[{"name":"The following authors have created the source code of \"Yandex Flavored Markdown\""},{"name":"published and distributed by YANDEX LLC as the owner:"},{"name":"Evgeny Uspenskiy euspenskiy@yandex-team.ru"},{"name":"Andrey Morozov amje@yandex-team.ru"},{"name":"David Nanyan dave@yandex-team.ru"},{"name":"Timur Sufiev tsufiev@yandex-team.ru"},{"name":"Igor Vernichenko igorvern@yandex-team.ru"},{"name":"Vladislav Kharitonov vladvlad@yandex-team.ru"},{"name":"Aleksandr Sinyatkin daff@yandex-team.ru"},{"name":"Mikhail Kharin lunatic174@yandex-team.ru"},{"name":"Evgeny Biriulin birman111@yandex-team.ru"},{"name":"Alexey Sizikov w100@yandex-team.ru"}],"maintainers":[{"name":"belym.a.2105","email":"belym.a.2105@gmail.com"}],"readme":"**русский** | [english](https://github.com/yandex-cloud/yfm-transform/blob/master/README.md)\n- - -\n\n[![NPM version](https://img.shields.io/npm/v/@diplodoc/transform.svg?style=flat)](https://www.npmjs.org/package/@diplodoc/transform)\n\n[@diplodoc/transform](https://www.npmjs.com/package/@diplodoc/transform) — пакет для трансформации Yandex Flavored Markdown в HTML.\n\nИспользуйте его в своем коде для работы с текстом во время выполнения программы. Например, чтобы отображать пользовательский контент.\n\n## Установка {#install}\n\n1. Установите пакет:\n\n    ```shell\n    npm i @diplodoc/transform\n    ```\n\n1. Подключите пакет в своем коде, используя функцию `require()` или `import()`:\n\n    ```javascript\n    const transform = require('@diplodoc/transform');\n    ```\n\n1. Для корректного отображения подключите в проект CSS-стили и клиентские скрипты:\n\n     ```css\n     @import '~@diplodoc/transform/dist/css/yfm.css';\n     ```\n\n     ```javascript\n     import '@diplodoc/transform/dist/js/yfm';\n     ```\n\n## Использование {#use}\n\nПакет предоставляет функцию `transform()`:\n* входные данные — строка с YFM и [настройки](settings.md);\n* возвращаемое значение — объект с полями `result` и `logs`.\n\n### Поле result\n\n`result` — объект результата, содержит поля:\n* `html` — строка с HTML.\n* `meta` — [метаданные](../../syntax/meta.md#meta) из переданного контента.\n* `title` — заголовок документа. Возвращается, если заданы настройки `extractTitle = true` или `needTitle = true`.\n* `headings` — список заголовков документа.\n\n### Поле logs\n\n`logs` — информация о процессе трансформации, включает массивы:\n* `error` — ошибки.\n* `warn` — предупреждения.\n* `info` — дополнительная информация.\n\n### Пример вызова функции\n\n```javascript\nconst fs = require('fs');\nconst transform = require('@diplodoc/transform');\n\nconst content = fs.readFileSync(filePath, 'utf');\nconst vars = { user: { name: 'Alice' } };\n\nconst {\n    result: {html, meta, title, headings},\n    logs,\n    } = transform(content, {vars});\n```\n\n\n## License\n\nMIT\n","readmeFilename":"README.ru.md"}