npm install enb-markdownПакет предоставляет набор ENB-технологий
для сборки Markdown-файлов, разложенных по методологии БЭМ,
и конвертации их в HTML с использованием пакета markdown-bemjson.
``sh`
$ npm install --save enb-markdown
Требования:
- Node.js версии 6.0.0 и выше
- базовые шаблоны для BEMHTML и BEMTREE, которые находятся в библиотеке bem-core или bem-bl
Предположим, документы разложены в формате Markdown с использованием БЭМ-наименования файлов.
`
articles/
└── article/
├── _part/
│ ├── article_part_first.markdown
│ └── article_part_second.markdown
└── article.markdown
Минимальная настройка сборки:
`js
var MarkdownTech = require('enb-markdown/techs/markdown'),
FileProvideTech = require('enb/techs/file-provider'),
bemTechs = require('enb-bem-techs');
module.exports = function(config) {
config.node('bundle', function(node) {
// get FileList
node.addTechs([
[FileProvideTech, { target: '?.bemdecl.js' }],
[bemTechs.levels, levels: ['articles']],
[bemTechs.deps],
[bemTechs.files]
]);
// build markdown file
node.addTech(MarkdownTech);
node.addTarget('?.markdown');
});
};
`
Декларация в bemdecl.js для сборки целевого документа в бандле, в том порядке в котором БЭМ-сущности задекларированы:
`js`
exports.blocks = [
{
"name": "article"
},
{
"name": "article",
"mods": [{
"name": "part",
"vals": [
{ "name": "first" },
{ "name": "second" }
]
}]
}
];
Минимальная настройка сборки:
`js
var FileProvideTech = require('enb/techs/file-provider'),
bemTechs = require('enb-bem-techs'),
bemtreeTech = require('enb-bemxjst/techs/bemtree'),
bemhtmlTech = require('enb-bemxjst/techs/bemhtml');
MarkdownTech = require('enb-markdown/techs/markdown'),
MarkdownToHtmlTech = require('enb-markdown/techs/markdown-to-html');
module.exports = function(config) {
config.node('bundle', function(node) {
node.addTechs([
// get FileList
[FileProvideTech, { target: '?.bemdecl.js' }],
[bemTechs.levels, levels: [
{ path: 'node_modules/bem-core/common.blocks', check: false },
'articles'
]],
[bemTechs.deps],
[bemTechs.files],
// bemtree
[bemtreeTech, { sourceSuffixes: ['bemtree', 'bemtree.js'] }],
// bemhtml
[bemhtmlTech, { sourceSuffixes: ['bemhtml', 'bemhtml.js'] }],
// markdown
[MarkdownTech],
// build HTML file
[MarkdownToHtmlTech]
]);
node.addTarget('?.html');
});
};
`
Для преобразования Markdown в HTML используется модуль markdown-bemjson для промежуточной конвертации в BEMJSON.
Опция markdownBemjsonOptions в технологии markdown-to-html используется для передачи опций markdown-bemjson, в том числе и правил преобразования options.rules.
В доступных свойствах правил преобразования есть возможность передать данные в шаблоны. Последним аргументом свойства передаётся объект с методами, которые передают данные по заданному пути в ctx в области видимости root-блока:
- setInRootCtx(path, value, [rewrite]) — добавляет свойство по заданному путиpath (Array|string)
- — путь к свойствуvalue (*)
- — значение[rewrite=true] (Boolean)
- — нужно ли перезаписать, если свойство существуетpushToRootCtx(path, value)
- — добавляет значение в массив по заданному путиpath (Array|string)
- — путь к свойствуvalue (*)
- — значение
Пример правила:
`js
module.exports = {
heading(text, level, raw, rootCtx) {
if (level === 1) {
rootCtx.setInRootCtx('title', raw, false);
}
return {
block: 'head',
mods: { level: level },
content: text
};
}
};
`
По умолчанию page, можно изменить опцией rootBlock.
Для именования Markdown-файлов по умолчанию используется расширение .markdown,
чтоб не пересекаться с документами внешних библиотек, которые подключаются как уровни переопределения.
Для использования более привычного расширения .md` нужно настроить отдельную конфигурацию для сборки Markdown из отдельного уровня переопределения, который не будет пересекаться с уровнями блоков вёрстки.
MIT Лицензия