Оглавление статьи
Описание проекта
Основная идея заключалась в создании технической документации, с описанием по работе с Gulp сборкой, которая была создана в рамках этой статьи. Сам проект был реализован с использованием этой же Gulp сборки.
Функционал проекта
Highlight code
Компонент Highlight code, позволяющий отображать на странице отформатированный код с возможностью копирования его по нажатию по специальной кнопке и дальнейшим его использованием.
Оглавление и Справочник терминов
Важная часть любой документации это навигация внутри статей. В рамках проекта было реализовано Оглавление, которое позволяет с первого взгляда ознакомиться с содержимым страницы и быстро перейти к нужной подтеме.
Так же была добавлена страница со Справочником терминов, который служит дополнением к базовому описанию документации.
Описание компонентов
Главной особенностью проекта является возможность визуализировать компонент на экране пользователя. С приведением примеров как компонент может быть использован в коде. Что позволяет освежить память по использованию и работе с компонентами, а так же быстро познакомиться с ними не открывая исходный код.
Навигационное меню
Главное навигационное меню умеет запоминать открыт или закрыт пункт меню, что позволяет пользователю при использовании сайта не разворачивать каждый раз пункты меню в ручную, при переходе по страницам документации.
Итоги проекта
Работа была выполнена в рампах Пет проекта. При верстке сайта параллельно была протестирована Gulp сборка, что позволило исправить найденные ошибки и дополнить/улучшить некоторый функционал.