Как добавить новую страницу на этот сайт

Все страницы этого сайта генерируются из файлов с расширением .md, расположенных в папке _doc. Ещё одна папка с контентом — это папка img, в которой хранятся изображения, не забывайте сдабривать ваши тексты картинками и скриншотами!

Для начала нужно выбрать раздел сайта, который вы хотите дополнить, и соответствующую папку внутри _docs. Создайте новый файл с расширением .md и в его начале сделайте служебную таблицу с метаинформацией — она не будет показываться на сайте, а будет использована генератором.

---
title: Название страницы, оно будет показано в меню
permalink: /url-страницы-он-должен-быть-указан-в-docs.yml/
---

После этой таблицы находится текст, размеченный Markdown, который будет превращён в HTML генератором.

Важнейший файл, который вам нужно будет исправить при добавлении страницы, — это _data/docs.yml. Этот файл размечен в формате YAML и содержит в себе структуру меню сайта. В качестве элемента раздела нужно указать URL страницы, без слешей.

Пару слов о генераторе

Этот сайт генерируется с помощью GitHub Pages, который использует генератор статических файлов Jekyll. Как можно видеть по истории коммитов, в качестве основы использована тема jekyll-doc-theme, которая была значительно упрощена и урезана.

Запуск сайта на своей машине

Перед тем как запушить свои изменения на GitHub, неплохо бы узнать как они будут выглядеть. Вот простая инструкции по запуску Jekyll, все что нужно сделать — это выполнить bundle exec jekyll serve. А для тех, кто не боится Docker, достаточно в корневой папке репозитория выполнить docker-compose up. В обоих случаях, результат можно увидеть открыв http://localhost:4000 в своём браузере. Теперь вы можете править исходные тексты страниц и ваш локальный сайт будет обновляться при каждом их сохранении.


Улучшить эту страницу