Каждый термин простыми словами
Словарь
Слова, которые встречаются в документации HERON и вообще вокруг сайтов, — каждое объяснено одним-двумя простыми предложениями. Термины сгруппированы по темам: страницы, поиск, публикация, инструменты.
Если слова здесь нет, гайды объясняют его там, где оно появляется впервые: heron docs --search "слово" найдёт это место.
Страницы
Markdown
Простой способ писать текст:
# — заголовок, - — пункт списка, **жирный** — жирный. Страницы HERON пишутся так, и их открывает любой текстовый редактор.Фронтматтер
Блок вверху страницы между двумя строками
---: title, описание, заголовок и другие настройки. В HERON он называется блоком для поиска и состоит из восьми групп.Секция
Блок страницы, который начинается с
## Заголовок {#якорь}. Тема рисует каждую секцию отдельным блоком.Якорь
Короткое латинское имя в фигурных скобках после заголовка секции, например
{#faq}. Подсказывает теме, где стоит блок, и становится частью адреса: /stranica/#faq.Ключ
Имя файла страницы без
.md вместе с папками: docs/guide. Ссылки пишутся ключами, поэтому продолжают работать, когда адрес меняется.Слаг
Часть адреса, которая называет страницу, например
about в /about/. По умолчанию это имя файла; поле slug меняет его, например для русского адреса.Тема
Внешний вид сайта: шаблоны, стили и тексты интерфейса в папке
theme/. Текстов страниц в ней нет.Шаблон
Файл темы, который рисует один тип страницы. Модуль — файл поменьше, он рисует один блок.
Конфигуратор
Анкета, которую вы заполняете командой
heron setup .: название, домен, контакты, реквизиты, вид организации, тема. Записывает ответы в site.yaml и подгоняет структуру сайта под ваш проект.Поиск и нейросети
SEO
Поисковая оптимизация: всё, что помогает поисковикам найти страницу, понять её и показать по нужному запросу.
Title и description
Название страницы и короткий текст, которые поисковик показывает в выдаче. Это не заголовок на самой странице.
Карта сайта
Файл
sitemap.xml со списком всех страниц, открытых для поиска. По нему поисковики находят новые страницы.robots.txt
Файл, который говорит поисковым роботам, куда можно заходить и где лежит карта сайта.
Canonical
Главный адрес страницы. Если страница открывается по нескольким адресам, canonical подсказывает поисковику, какой из них основной.
hreflang
Пометка в странице со списком её переводов, чтобы поисковик показал русскому читателю русскую версию.
schema.org
Общий словарь, которым описывают, о чём страница: компания, человек, статья, вопросы и ответы. Поисковики строят по нему расширенные сниппеты.
JSON-LD
Формат, в котором HERON пишет данные schema.org: небольшой блок данных внутри страницы, читателю не виден.
llms.txt
Простой текстовый файл в корне сайта с описанием и списком важных страниц для нейросетей. HERON собирает его сам. Подробнее про llms.txt
Индексация
Поисковик добавляет страницу в свою базу, чтобы она могла появиться в выдаче. Тестовая сборка закрыта от индексации.
Публикация
Статический сайт
Сайт из готовых файлов: HTML-страниц, картинок, стилей. Сервер только отдаёт их, ничего не вычисляя на каждый визит. Что такое статический сайт
Сборка
Превращение папки сайта в готовые файлы в
dist/. Строгая сборка считает каждое предупреждение ошибкой.Домен
Имя сайта, например
heron.software. Его арендуют у регистратора.DNS
Адресная книга интернета. Запись DNS связывает домен с сервером.
HTTPS
Защищённое соединение, в браузере это замок. Включается бесплатным сертификатом.
Хостинг
Место, где лежат файлы сайта и откуда они уходят посетителям: сервер, GitHub Pages, Cloudflare Pages.
nginx
Небольшой быстрый веб-сервер, который отдаёт готовые страницы посетителям. HERON пишет его конфиг вместе с сайтом.
301
Ответ сервера «страница переехала навсегда» с новым адресом. Позиции в поиске переезжают вместе с ней.
410
Ответ сервера «страницы больше нет и не будет». Такие адреса поисковики убирают быстрее, чем после 404.
404
Ответ сервера «такой страницы нет». HERON показывает свою страницу 404 на языке адреса.
Инструменты
Docker
Программа, которая запускает другие программы в закрытой коробке, и компьютер остаётся чистым. HERON работает в ней.
Образ
Готовая упаковка программы со всем, что ей нужно. HERON приходит образом, и готовый сайт тоже можно упаковать в образ.
Контейнер
Запущенный образ. Он видит только то, что вы разрешили, например папку сайта.
Реестр
Хранилище образов, например GHCR на GitHub или Docker Hub.
Тег
Имя версии образа:
prod, beta, 0.1.0.Git
Программа, которая хранит каждое изменение папки: видна история, можно вернуться назад.
Репозиторий
Папка вместе с историей git, обычно на GitHub.
Коммит и push
Коммит сохраняет набор изменений в git, push отправляет их на GitHub.
Workflow
Файл в
.github/workflows/, который говорит GitHub, что делать после каждого push, например собрать образ сайта. Ещё говорят CI или GitHub Actions.Токен
Длинный пароль для программ с ограниченными правами. Токены GitHub и Docker Hub позволяют серверу скачать закрытый образ. Не храните токены в папке сайта и в git.
pip
Установщик программ на Python. Через него HERON можно поставить вместо Docker.
Терминал
Окно, где команды вводят текстом, а не мышкой: Терминал на macOS, PowerShell или окно WSL на Windows, любой терминал на Linux. Docker и терминал
Команда
Одна строка, которую вводят в терминале и запускают клавишей Enter, например
heron build .. Несколько команд через && выполняются по очереди и останавливаются на первой ошибке.Текущая папка
Папка, «в которой» находится терминал. Точка
. в команде означает именно её; cd my-site переходит в другую.Текстовый редактор
Программа для простых текстовых файлов, например VS Code. Не Word: сайту нужен чистый текст без скрытого оформления. Какой редактор выбрать
localhost
Ваш собственный компьютер, каким его видит браузер.
localhost:8000 открывает просмотр, который HERON запускает у вас; больше его никто не видит.Порт
Число после двоеточия в
localhost:8000. Одну программу слушает один порт; если он занят, возьмите другое число.