{"id":15791390,"url":"https://github.com/levonet/enb-markdown","last_synced_at":"2025-03-31T18:48:44.794Z","repository":{"id":57225084,"uuid":"78755098","full_name":"levonet/enb-markdown","owner":"levonet","description":"Markdown techs for ENB","archived":false,"fork":false,"pushed_at":"2017-04-27T06:00:58.000Z","size":31,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-23T09:22:35.909Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/levonet.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-12T14:45:04.000Z","updated_at":"2017-04-29T13:30:25.000Z","dependencies_parsed_at":"2022-08-24T11:01:08.757Z","dependency_job_id":null,"html_url":"https://github.com/levonet/enb-markdown","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levonet%2Fenb-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levonet%2Fenb-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levonet%2Fenb-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levonet%2Fenb-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/levonet","download_url":"https://codeload.github.com/levonet/enb-markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246523890,"owners_count":20791443,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-04T23:00:46.873Z","updated_at":"2025-03-31T18:48:44.766Z","avatar_url":"https://github.com/levonet.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# enb-markdown\n[![NPM version](https://img.shields.io/npm/v/enb-markdown.svg?style=flat)](https://www.npmjs.com/package/enb-markdown)\n[![Build Status](https://travis-ci.org/levonet/enb-markdown.svg?branch=master)](https://travis-ci.org/levonet/enb-markdown)\n[![Coverage Status](https://coveralls.io/repos/github/levonet/enb-markdown/badge.svg?branch=master)](https://coveralls.io/github/levonet/enb-markdown?branch=master)\n\nПакет предоставляет набор [ENB](https://ru.bem.info/toolbox/enb/)-технологий\nдля сборки Markdown-файлов, разложенных по [методологии БЭМ](https://ru.bem.info/method/),\nи конвертации их в HTML с использованием пакета [markdown-bemjson](https://github.com/bem-contrib/markdown-bemjson).\n\n## Установка\n\n```sh\n$ npm install --save enb-markdown\n```\n\n**Требования:**\n\n  - `Node.js` версии `6.0.0` и выше\n  - базовые шаблоны для BEMHTML и BEMTREE, которые находятся в библиотеке [bem-core](https://ru.bem.info/libs/bem-core/) или [bem-bl](https://ru.bem.info/libs/bem-bl/)\n\n## Быстрый старт\n\n### Сборка бандла с технологией Markdown\n\nПредположим, документы разложены в формате Markdown с использованием БЭМ-наименования файлов.\n\n```\narticles/\n└── article/\n    ├── _part/\n    │   ├── article_part_first.markdown\n    │   └── article_part_second.markdown\n    └── article.markdown\n```\n\nМинимальная настройка сборки:\n\n```js\nvar MarkdownTech = require('enb-markdown/techs/markdown'),\n    FileProvideTech = require('enb/techs/file-provider'),\n    bemTechs = require('enb-bem-techs');\n\nmodule.exports = function(config) {\n    config.node('bundle', function(node) {\n        // get FileList\n        node.addTechs([\n            [FileProvideTech, { target: '?.bemdecl.js' }],\n            [bemTechs.levels, levels: ['articles']],\n            [bemTechs.deps],\n            [bemTechs.files]\n        ]);\n\n        // build markdown file\n        node.addTech(MarkdownTech);\n        node.addTarget('?.markdown');\n    });\n};\n```\n\nДекларация в `bemdecl.js` для сборки целевого документа в бандле, в том порядке в котором БЭМ-сущности задекларированы:\n\n```js\nexports.blocks = [\n    {\n        \"name\": \"article\"\n    },\n    {\n        \"name\": \"article\",\n        \"mods\": [{\n            \"name\": \"part\",\n            \"vals\": [\n                { \"name\": \"first\" },\n                { \"name\": \"second\" }\n            ]\n        }]\n    }\n];\n```\n\n### Сборка HTML из Markdown-технологии\n\nМинимальная настройка сборки:\n\n```js\nvar FileProvideTech = require('enb/techs/file-provider'),\n    bemTechs = require('enb-bem-techs'),\n    bemtreeTech = require('enb-bemxjst/techs/bemtree'),\n    bemhtmlTech = require('enb-bemxjst/techs/bemhtml');\n    MarkdownTech = require('enb-markdown/techs/markdown'),\n    MarkdownToHtmlTech = require('enb-markdown/techs/markdown-to-html');\n\nmodule.exports = function(config) {\n    config.node('bundle', function(node) {\n        node.addTechs([\n            // get FileList\n            [FileProvideTech, { target: '?.bemdecl.js' }],\n            [bemTechs.levels, levels: [\n                { path: 'node_modules/bem-core/common.blocks', check: false },\n                'articles'\n            ]],\n            [bemTechs.deps],\n            [bemTechs.files],\n\n            // bemtree\n            [bemtreeTech, { sourceSuffixes: ['bemtree', 'bemtree.js'] }],\n\n            // bemhtml\n            [bemhtmlTech, { sourceSuffixes: ['bemhtml', 'bemhtml.js'] }],\n\n            // markdown\n            [MarkdownTech],\n\n            // build HTML file\n            [MarkdownToHtmlTech]\n        ]);\n\n        node.addTarget('?.html');\n    });\n};\n```\n\n## Особенности работы пакета\n\n### Правила преобразования в HTML\n\nДля преобразования Markdown в HTML используется модуль [markdown-bemjson](https://github.com/bem-contrib/markdown-bemjson) для промежуточной конвертации в BEMJSON.\n\nОпция `markdownBemjsonOptions` в технологии `markdown-to-html` используется для передачи [опций markdown-bemjson](https://github.com/bem-contrib/markdown-bemjson#contructoroptions), в том числе и правил преобразования `options.rules`.\n\nВ доступных [свойствах](https://github.com/bem-contrib/markdown-bemjson#Доступные-свойства-для-правил) правил преобразования есть возможность передать данные в шаблоны. Последним аргументом свойства передаётся объект с методами, которые передают данные по заданному пути в `ctx` в области видимости root-блока:\n\n  - `setInRootCtx(path, value, [rewrite])` — добавляет свойство по заданному пути\n    - `path (Array|string)` — путь к свойству\n    - `value (*)` — значение\n    - `[rewrite=true] (Boolean) ` — нужно ли перезаписать, если свойство существует\n  - `pushToRootCtx(path, value)` — добавляет значение в массив по заданному пути\n    - `path (Array|string)` — путь к свойству\n    - `value (*)` — значение\n\nПример правила:\n\n```js\nmodule.exports = {\n    heading(text, level, raw, rootCtx) {\n        if (level === 1) {\n            rootCtx.setInRootCtx('title', raw, false);\n        }\n\n        return {\n            block: 'head',\n            mods: { level: level },\n            content: text\n        };\n    }\n};\n```\n\n### Root-блок\n\nПо умолчанию `page`, можно изменить опцией `rootBlock`.\n\n### Расширение документа\n\nДля именования Markdown-файлов по умолчанию используется расширение `.markdown`,\nчтоб не пересекаться с документами внешних библиотек, которые подключаются как уровни переопределения.\n\nДля использования более привычного расширения `.md` нужно настроить отдельную конфигурацию для сборки Markdown из отдельного уровня переопределения, который не будет пересекаться с уровнями блоков вёрстки.\n\n\u003c!-- TODO: Пример подключения сборки документов из отдельного уровня --\u003e\n\n## Лицензия\n\n[MIT](http://en.wikipedia.org/wiki/MIT_License) Лицензия\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flevonet%2Fenb-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flevonet%2Fenb-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flevonet%2Fenb-markdown/lists"}