Альтернативная документация для Compass
Опубликовал Александр Шабуневич — 20 Сентябрь 2012, 12:04
Вчера я написал про CSS-препроцессоры, похвалив SASS и Compass. Но когда я начал пользоваться Компасом, то выяснилось, что документация у последнего оставляет желать лучшего. Нет, она полная и всё описывает, но вот пользоваться ей не очень удобно: простые статичные страницы с несколькими уровнями иерархии. И, как назло, нет даже шпаргалок (cheatsheets), перечисляющих примеси (mixins) и функции. В общем, пришлось делать что-то самому.
Сначала я хотел сделать именно шпаргалку в формате PDF по аналогии с Zen Coding, но в процессе понял, что информативность страдает: примеров нет, описаний не уместишь. Тогда я вспомнил про чудесный альтернативный API-браузер jQuery, которым сам постоянно пользуюсь. Он работает через AJAX, имеет мгновенный поиск и вообще очень удобен. А так как исходники документации для Компаса свободно доступны, я решил сделать аналогичный проект для него.
Сайт и документация Компаса написаны на мини-движке nanoc, который генерирует статичные страницы из набора haml- и sass- компонентов. Пару вечеров у меня ушло на то, чтобы разобраться что там к чему, а также вспомнить Ruby, который я когда-то давно пытался изучать, но потом забросил. Вообще, руби клевый язык — мне он понравился даже больше питона. И хотя мой код вышел кривым, я видел как его пишут люди с опытом.
В целом, документацию я сделал как планировал. Пришлось вырезать примеры — точнее, дать ссылки на оригинальный сайт. Зато на главной есть список всех функций и примесей для быстрого доступа. В целом, как мне кажется, получилось удачно — лично для меня гораздо удобнее оригинала. Оформление хотел сделать своё, но потом решил, что надежнее придерживаться авторских стилей, тем более что они мне нравятся.
Исходники проекта я выложил на гитхаб, он же хостит документацию (github pages) в виде статичного сайта по адресу compass.aether.ru. Может быть позже я добавлю туда еще справочник родных функций SASS.
Compass API — сайт с документацией.