Как разрабатывать сайт библиотеки

Сайт библиотеки находится в репозитории бибилиотеки, в ветке gh-pages.

Сайт состоит из:

• главной страницы
• страниц в папке pages
• страниц с документаций блоков (в sets)

Данные для для блоков хранятся в ветке master. В ветке gh-pages хранится дизайн сайта и результаты генерации из данных. Данные вносятся в ветку gh-pages из ветки master путём git merge

Подготовка среды разработки

• fork репозитория bem-bl
• склонировать свой fork
• checkout ветки gh-pages
• npm install в корне проекта

Как изменить страницы сайта?

Изменения на страницах блоков

Где хранить/изменять данные?

Документация блока делается для определённого набора (set). Например common-desktop. Документация блока - это страница, описывающая блок, его элементы и модификаторы. На странице блока также располагаются примеры использования блока (в iframe).

Блок, его элементы и модификаторы описываютя в технологиях title.txt (для названий) и wiki (для текста). Файлы описаний имеют локализационные суффиксы. Например,

b-link/
    _pseudo/
        b-link_pseudo_yes.bemhtml
        b-link_pseudo_yes.ru.title.txt
        b-link_pseudo_yes.en.title.txt
    b-link.bemhtml
    b-link.ru.wiki
    b-link.ru.title.txt

В технологии wiki используется wiki-диалект shmakowiki.

Измеенения в документации блоков должны вноситься в ветке master

Как перегенерировать страницы?

Для обновления документации нужно сделать git merge master в ветке gh-pages, а затем перестроить страницы при помощи команды make:

Перегенерировать примеры блока:

make -C sets/common-desktop b-link/examples -B

Примеры не локализуются

Перегенерировать страницы блока:

make -C sets/common-desktop b-link -B

Также генерирует примеры блока. Производятся html-страницы документации в локалях ru и en.