Commit 7b4ca7bf authored by Nikolay Gromov's avatar Nikolay Gromov

Добавил в описание инструкцию по работе со сторонними модулями

parent b96cbe66
......@@ -96,6 +96,15 @@ node createBlock.js demo-block pug js # создаст папку блока, de
Если блок уже существует, файлы не будут затёрты, но создадутся те файлы, которые ещё не существуют.
## Сторонние npm-модули
Если нужно взять в сборку сторонний модуль, то после его установки:
1. Прописать `require` в js-файле проектного блока (там же писать всё, что касается работы с этим модулем). Если сторонний модуль нужен без привязки к какому-либо проектому блоку, прописать `require` в `src/js/script.js` (см. пример в файле).
2. Прописать стилевой файл модуля в `addStyleBefore` файла `config.js` (если нужно).
3. Прописать дополнительные файлы модуля в `addAssets` файла `config.js` (если нужно) с указанием в какую папку их копировать.
## Разметка
Используется [pug](https://pugjs.org/api/getting-started.html).
......
/* global module */
let config = {
"notGetBlocks": [
"blocks-demo.html",
'notGetBlocks': [
'blocks-demo.html',
],
"ignoredBlocks": [
"no-js",
'ignoredBlocks': [
'no-js',
],
"alwaysAddBlocks": [
// "sprite-svg",
// "sprite-png",
// "object-fit-polyfill",
'alwaysAddBlocks': [
// 'sprite-svg',
// 'sprite-png',
// 'object-fit-polyfill',
],
"addStyleBefore": [
"src/scss/variables.scss",
"src/scss/mixins.scss",
// "somePackage/dist/somePackage.css", // для "node_modules/somePackage/dist/somePackage.css",
'addStyleBefore': [
'src/scss/variables.scss',
'src/scss/mixins.scss',
// 'somePackage/dist/somePackage.css', // для 'node_modules/somePackage/dist/somePackage.css',
],
"addStyleAfter": [
// "src/scss/print.scss",
'addStyleAfter': [
// 'src/scss/print.scss',
],
"addJsBefore": [],
"addJsAfter": [
"./script.js",
'addJsBefore': [
// 'somePackage/dist/somePackage.js', // для 'node_modules/somePackage/dist/somePackage.js',
],
"addAssets": {
"src/fonts/demo-empty-open-sans.woff2": "fonts/",
"src/img/demo-*.{png,svg,jpg,jpeg}": "img/",
// "src/favicon/*.{png,ico,svg,xml,webmanifest}": "img/favicon",
'addJsAfter': [
'./script.js',
],
'addAssets': {
'src/fonts/demo-empty-open-sans.woff2': 'fonts/',
'src/img/demo-*.{png,svg,jpg,jpeg}': 'img/',
// 'src/favicon/*.{png,ico,svg,xml,webmanifest}': 'img/favicon',
// 'node_modules/somePackage/images/*.{png,svg,jpg,jpeg}': 'img/',
},
"dir": {
"src": "src/",
"build": "build/",
"blocks": "src/blocks/"
'dir': {
'src': 'src/',
'build': 'build/',
'blocks': 'src/blocks/'
}
};
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment