Markdown за 10 минут

Когда вы пишете письмо от руки, вы подчёркиваете заголовок и ставите точки перед пунктами. Markdown делает то же самое символами клавиатуры. HERON читает эти символы и превращает их в настоящие заголовки, списки и ссылки на сайте.

HTML вы не пишете никогда. Вы пишете текст, который легко читать ещё до того, как он стал страницей.

Когда нужна эта страница: перед тем как написать или поменять первую страницу. Когда можно пропустить: если вы уже пишете в Markdown — сразу переходите к части про HERON.

Абзац — одна или несколько строк текста. Пустая строка между двумя кусками текста делает два абзаца. Одиночный перенос строки внутри абзаца не учитывается, поэтому длинные предложения можно переносить как удобно.

Это первый абзац.
Он продолжается на этой строке.

Это второй абзац.

Самая частая ошибка новичка — забыть пустую строку перед списком или заголовком. Если на странице что-то слиплось, добавьте пустую строку.

Маркированный список: каждая строка начинается с дефиса и пробела. Нумерованный: цифра, точка и пробел. До и после списка — пустая строка.

Что вы получите:

- карту сайта для поисковиков
- страницы на двух языках
- фото во всех размерах

Как начать:

1. Установите Docker.
2. Создайте сайт.
3. Откройте его в браузере.

В HERON пункт списка, который начинается с жирной фразы с точкой, особенный: - **Карта сайта.** Все страницы с датой. Жирная часть становится термином, и тема может показать её отдельно. См. Формы секций.

Ссылка — текст в квадратных скобках, затем адрес в круглых. На страницы своего сайта пишите адрес от корня и без языка: HERON сам подставит нужную языковую версию.

Прочитайте [гайд о первом сайте](/docs/first-site/) или откройте [GitHub](https://github.com/FMSTM/HERON).

Картинка — то же самое с восклицательным знаком впереди. Текст в квадратных скобках описывает картинку для тех, кто её не видит, и для поисковиков. Положите фото в папку media/ и ссылайтесь на него оттуда.

![Цапля стоит на мелководье](media/examples/photo.jpg)

HERON сделает лёгкие копии фото в нескольких размерах, чтобы оно быстро грузилось на телефоне.

Слово в обратных кавычках показывается как код: site.yaml, heron build. Целая команда идёт в блок: три обратные кавычки на строке до и после, после первых трёх — название языка.

```bash
heron build . --env prod --strict
```

На сайте у блока кода появится кнопка «Копировать».

Колонки разделяются вертикальной чертой |. Вторая строка из дефисов отделяет шапку от строк.

| Тариф | Цена |
|---|---|
| Базовый | Бесплатно |
| Команда | По запросу |

Выравнивать колонки не нужно. HERON прочитает их и так.

У страницы HERON две части. Вверху, между двумя строками из трёх дефисов, — настройки (их называют фронтматтер): что покажут поисковики, заголовок, короткое описание. Под ними — текст, разбитый на секции.

---
title: "Стоматология в Вене: лечение и цены"
h1: "Ваша улыбка — наша забота"
description: "Лечение, импланты и чистка в Вене. Цены, команда и онлайн-запись."
---

Короткое вступление: два-три предложения под заголовком.

## Наши услуги {#services}

### Чистка
Два раза в год — и зубы здоровы.

- **Длится.** 45 минут.
- **Цена.** От 90 евро.

### Импланты
Новый зуб, который выглядит и работает как свой.

- **Длится.** Два визита.

## Вопросы {#faq}

### Это больно?
Нет. Мы используем местную анестезию.

Что с этим происходит:

• title уходит во вкладку браузера и в результат поиска. До 60 знаков.
• h1 — большой заголовок на странице. Он для тех, кто страницу уже открыл, поэтому может отличаться от title.
• description — строка под результатом поиска. До 155 знаков.
• Текст до первого ## становится вступлением под заголовком.
• ## Наши услуги {#services} начинает секцию. Слова — заголовок, который видят люди. Часть в фигурных скобках, якорь, — имя секции для темы и для ссылок вида #services. Только маленькие латинские буквы, цифры и дефисы.
• Группы ### со списками становятся карточками; ### без списков под {#faq} — вопросами и ответами, и поисковики получают их как разметку FAQ.

Как рисуется каждый вид секции, с живыми примерами, — на странице Формы секций. Все поля настроек — в Формате страницы.