Commit 6fcca0a0 authored by Nikolay Gromov's avatar Nikolay Gromov

Уточнил описание

parent f0305fa2
...@@ -20,6 +20,8 @@ ...@@ -20,6 +20,8 @@
"скролл*", "скролл*",
"селект*", "селект*",
"чекбокс*", "чекбокс*",
"раскомментирова*",
"закомментирова*",
"псевдоселектор*", "псевдоселектор*",
"бургер*", "бургер*",
"псевдоэлемент*", "псевдоэлемент*",
......
...@@ -91,27 +91,104 @@ demo-block/ # Папка блока ...@@ -91,27 +91,104 @@ demo-block/ # Папка блока
### Подключение блоков ### Подключение блоков
Список используемых блоков и дополнительных подключаемых файлов указан в `./projectConfig.json`. Список используемых блоков и дополнительных подключаемых файлов указан в `./projectConfig.json`. Список файлов и папок, взятых в обработку можно увидеть в терминале, если раскомментировать строку `console.log(lists);` в `gulpfile.js`.
`blocks` — объект с блоками, используемыми на проекте. Каждый блок — отдельная папка с файлами, по умолчанию лежат в `./src/blocks/`. #### `blocks`
Объект с блоками, используемыми на проекте. Каждый блок — отдельная папка с файлами, по умолчанию лежат в `./src/blocks/`.
Каждое подключение блока — массив, который можно оставить пустым или указать файлы элементов или модификаторов, если они написаны в виде отдельных файлов. В обоих случаях в обработку будут взяты одноименные стилевые файлы, js-файлы и картинки из папки `img/` блока. Каждое подключение блока — массив, который можно оставить пустым или указать файлы элементов или модификаторов, если они написаны в виде отдельных файлов. В обоих случаях в обработку будут взяты одноименные стилевые файлы, js-файлы и картинки из папки `img/` блока.
`addCssBefore` — массив с дополнительными стилевыми файлами, которые будут взяты в компиляцию ПЕРЕД стилевыми файлами блоков. Пример, подключающий 3 блока:
```
"blocks": {
"page": [],
"page-header": [],
"page-footer": []
}
```
#### `addCssBefore`
Массив с дополнительными стилевыми файлами, которые будут взяты в компиляцию ПЕРЕД стилевыми файлами блоков.
Пример, берущий в компиляцию переменные, примеси, функции и один дополнительный файл из папки зависимостей (он будет преобразован в css-импорт, который при постпроцессинге ([postcss-import](https://github.com/postcss/postcss-import)) будет заменен на содержимое файла).
```
"addCssBefore": [
"./src/scss/variables.scss",
"./src/scss/mixins.scss",
"./src/scss/functions.scss",
"../../node_modules/owl.carousel/dist/assets/owl.carousel.css"
],
```
#### `addCssAfter`
Массив с дополнительными стилевыми файлами, которые будут взяты в компиляцию ПОСЛЕ стилевых файлов блоков.
```
"addCssAfter": [
"./src/scss/print.scss"
],
```
#### `singleCompiled`
Массив стилевых файлов, которые будут скомпилированы независимо.
`addCssAfter` — массив с дополнительными стилевыми файлами, которые будут взяты в компиляцию ПОСЛЕ стилевых файлов блоков. Пример: указанный файл будет скомпилирован в папку сборки как `blocks-library.css`
`singleCompiled` — массив стилевых файлов, которые будут скомпилированы по отдельности. ```
"singleCompiled": [
"./src/scss/blocks-library.scss"
],
```
#### `addJsBefore`
Массив js-файлов, которые будут взяты в обработку (конкатенация/сжатие) ПЕРЕД js-файлами блоков.
Пример, добавляющий в список обрабатываемых js-файлов несколько зависимостей:
```
"addJsBefore": [
"./node_modules/jquery/dist/jquery.min.js",
"./node_modules/jquery-migrate/dist/jquery-migrate.min.js",
"./node_modules/nouislider/distribute/nouislider.js"
],
```
#### `addJsAfter`
`addJsBefore` — массив js-файлов, которые будут взяты в обработку (конкатенация/сжатие) ПЕРЕД js-файлами блоков. Массив js-файлов, которые будут взяты в обработку (конкатенация/сжатие) ПОСЛЕ js-файлов блоков.
Пример, добавляющий в конец списка обрабатываемых js-файлов глобальный скрипт.
```
"addJsAfter": [
"./src/js/global-script.js"
],
```
#### `addImages`
Массив дополнительных изображений, добавляемый ПЕРЕД массивом изображений из блоков (внимание: при совпадении имен файлов, файлы из блоков имеют более высокий приоритет и затрут файлы из этого массива).
```
"addImages": [
"./src/img/*.{jpg,jpeg,gif,png,svg,ico}"
],
```
`addJsAfter` — массив js-файлов, которые будут взяты в обработку (конкатенация/сжатие) ПОСЛЕ js-файлов блоков. #### `copiedCss`
`addImages` — массив дополнительных изображений, добавляемый ПЕРЕД массивом изображений из блоков (внимание: при совпадении имен файлов, файлы из блоков имеют более высокий приоритет и затрут файлы из этого массива) Массив css-файлов, которые копируются в папку сборки, подпапку `css/`
`copiedCss` — массив css-файлов, которые копируются в папку сборки, подпапку `css/` #### `copiedJs`
`copiedJs` — массив js-файлов, которые копируются в папку сборки, подпапку `js/` Массив js-файлов, которые копируются в папку сборки, подпапку `js/`
**ВНИМАНИЕ!** Это JSON. Это строгий синтаксис, у последнего элемента в любом контексте не должно быть запятой в конце строки. **ВНИМАНИЕ!** Это JSON. Это строгий синтаксис, у последнего элемента в любом контексте не должно быть запятой в конце строки.
......
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