Commit 794204b6 authored by Nikolay Gromov's avatar Nikolay Gromov

Описание: добавил и подправил

parent 44c6483e
...@@ -18,14 +18,14 @@ ...@@ -18,14 +18,14 @@
## Команды ## Команды
```bash ```bash
npm start # запуск сервера разработки (сборка БЕЗ библиотеки блоков) npm start # запуск сервера разработки (сборка БЕЗ библиотеки блоков)
npm run build # сборка БЕЗ библиотеки блоков и без запуска сервера разработки npm run build # сборка БЕЗ библиотеки блоков и без запуска сервера разработки
npm run wlib # запуск сервера разработки (сборка проекта с библиотекой блоков) npm run wlib # запуск сервера разработки (сборка проекта с библиотекой блоков)
npm run deploy # cборка проекта (с библиотекой) и отправка содержимого папки сборки на gh-pages (нужен репозиторий на github.com) npm run deploy # cборка проекта (с библиотекой) и отправка содержимого папки сборки на gh-pages (нужен репозиторий на github.com)
npm run test # проверка всех pug-, scss- и js-файлов на соответствие правилам (см. .pug-lintrc, .stylelintrc и eslintrc соответственно) npm run test # проверка всех pug-, scss- и js-файлов на соответствие правилам (см. .pug-lintrc, .stylelintrc и eslintrc соответственно)
npm run test:pug # проверить только pug-файлы npm run test:pug # проверить только pug-файлы
npm run test:style # проверить только scss-файлы npm run test:style # проверить только scss-файлы
npm run test:js # проверить только js-файлы npm run test:js # проверить только js-файлы
``` ```
...@@ -75,13 +75,13 @@ src/ # Исходники ...@@ -75,13 +75,13 @@ src/ # Исходники
Возможное содержимое блока: Возможное содержимое блока:
```bash ```bash
demo-block/ # Папка блока. demo-block/ # Папка блока.
bg-img/ # Изображения для использования в стилях (не обрабатываются автоматикой). bg-img/ # Изображения для использования в стилях (не обрабатываются автоматикой).
img/ # Изображения, используемые блоком (копируются в папку сборки). img/ # Изображения, используемые блоком (копируются в папку сборки).
demo-block.pug # Разметка (pug-примесь, отдающая разметку блока, описание API примеси). demo-block.pug # Разметка (pug-примесь, отдающая разметку блока, описание API примеси).
demo-block.scss # Стилевой файл блока. demo-block.scss # Стилевой файл блока.
demo-block.js # js-файл блока. demo-block.js # js-файл блока.
readme.md # Описание для документации, подсказки. readme.md # Описание для документации, подсказки.
``` ```
...@@ -119,6 +119,21 @@ node createBlock.js demo-block pug js # создаст папку блока, de ...@@ -119,6 +119,21 @@ node createBlock.js demo-block pug js # создаст папку блока, de
4. [postcss-inline-svg](https://github.com/TrySound/postcss-inline-svg) 4. [postcss-inline-svg](https://github.com/TrySound/postcss-inline-svg)
6. [postcss-object-fit-images](https://github.com/ronik-design/postcss-object-fit-images) (в паре с [полифилом](https://github.com/bfred-it/object-fit-images)) 6. [postcss-object-fit-images](https://github.com/ronik-design/postcss-object-fit-images) (в паре с [полифилом](https://github.com/bfred-it/object-fit-images))
### Стилевой код-гайд
Автопроверка с [stylelint](https://stylelint.io/) и плагинами. См. `.stylelintrc`.
1. БЭМ-именование: `__` — разделитель элемента, `--` — разделитель модификатора.
2. Один Блок = один стилевой файл.
3. Очередность селекторов:
- Инклуды примесей
- Стилевые правила сущности
- Медиаусловия
- Псевдоселекторы и псевдоэлементы
- Сторонние вложенные селекторы
- Элементы блока
- Модификаторы блока
## Скрипты ## Скрипты
......
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