«Слэйт»
Недавно зарелизилась первая версия ББК, а вместе с ней и сайт проекта, о котором я хочу вам рассказать. Точнее, о «Слэйте» — каркасе этого сайта.
Slate
«Слэйт» представляет собой шаблон «резинового» сайта-одностраничника с возможностью полной кастомизации внешнего вида. Содержимое для страниц собирается из маркдаун-файлов. Хоть проект и позиционируется как конструктор промостраниц для документации АПИ (чаще всего его используют именно в этих целях), его гибкость позволяет разрабатывать и небольшие статичные сайты. Примером тому сайт ББК — он содержит несколько разделов, каждый из которых состоит из своего набора маркдаун-файлов.
К слову, сайт ББК состоит из двух репозиториев: самого сайта со «Слэйтом», файлами для главной страницы, и репозитория с документацией. Такое разделение удобно с точки зрения коллективных доработок документации, потому как она находится в отдельном репозитории, доступном для правок любому желающему. Да и к тому же, история коммитов документации отделена от истории основного сайта.
А теперь вернёмся к «Слэйту»…
Как с этим жить
Вам потребуется билд-сервер — машина с установленным «Руби» — для сборки всех кусочков страницы воедино: ЦСС-файлы, ява-скрипты, маркдаун-файлы. Это можно делать и на боевом сервере, прямо во время публикации новой версии, но хорошей практикой является обратное — сборка не на бою, тестирование и только в случае успеха — выкатка в бой уже собранной версии.
На «Гитхабе» есть документация, в которой подробно освещены вопросы, начиная от установки и сборки билда, заканчивая возможностями по кастомизации «Слэйта».
Итого, схема работы следующая.
- Правим ЦСС, ЯС, ХТМЛ.
- Размещаем .md-файл с текстом, который хотим видеть на странице.
- Запускаем консольную команду и получаем в каталоге build/ готовый сайт.
Если вам нужно быстро выкатить документацию АПИ с приятным резиновым дизайном, не теряя время на разработку сайта — берите «Слэйт».
Сайты, сделанные на «Слэйте»: