Публикация с GitHub Pages, теперь проще, на раз, два, три.
Публикация сайта или документации приложения с помощью GitHub Pages теперь требует меньше шагов — если быть точнее три:
1. Создание репозитория (либо навигация к существующему репозиторию)
2. Создание коммита маркдаун файла через веб интерфейс, как и с любым другим файлом
3. Активация GitHub Pages через настройки репозитория.
Вот и все — теперь у вас новый сайт. Если вы уже знакомы с Github Pages, то возможно заинтересуетесь, как мы упростили за кулисами создание публикаций:
1. Все маркдаун файлы теперь рендерятся с помощью GitHub Pages, тем самым экономя ваше время на добавление YAML (метадата на самом верху файла разделенна с помощью — s) в каждый файл.
2. Мы используем README файл как индекс страницу в случае, если у вас нет index.md (index.html), как при использовании репозитория на GitHub.
3. Если вы не укажете тему в конфигурационном файле сайта (или вообще его не имеете), мы используем тему по умолчанию, подходящую наиболее, согласно маркдауну, где-нибудь еще на GitHub.
4. Если в исходном файле нет разметки, мы зададим соответствующую контенту. Например: страницы получают разметку страницы, либо разметку по умолчанию, если ее не существует.
5. Если страница не имеет определенного заголовка и файл начинается с заголовков H1, H2, H3, мы используем их вместо заголовка.
С помощью этих улучшений вы сможете разместить свой первый (или сотый) вебсайт в пару кликов, или задокументировать проект просто добавив маркдаун файл в папку /docs внутри вашего репозитория. Конечно вы можете делать изменения в дополнительной кастомизации (изменение исходной темы собственной разметкой или стилем).
В то время как эти изменения не затрагивают большинство существующих сайтов, продвинутые пользователи смогут найти пару подводных камней:
1. Если сайт пройдет по всем страницам, то вы возможно обнаружите дополнительные страницы (README файл вендорной зависимости) в списке. Вы можете их исключить при помощи директивы конфигурационного файла exclude.
2. Если вы не указываете разметку страницы или заголовок и не хотите их устанавливать, вам необходимо указать эти значения как null.
Если же вы вообще не нуждаетесь в этих фичах, вы можете отменить их добавив файл.nojekyll в корневую директорию сайта.
Таким образом процесс GitHub Pages является прозрачным и настраиваемым насколько возможно, все перечисленные фичи включены, как Jekyll плагины с открытым исходным кодом, а именно Jekyll Optional Front Matter, Jekyll README Index, Jekyll Default Layout, и Jekyll Titles из Headings.
Повторимся, эти изменения не влияют на существующие билды (вы можете безопасно ими пользоваться). Если есть какие-либо вопросы обращайтесь.
Статью перевел timurziev. Оригинал на Github.com доступен по ссылке.