Синтаксис YAML с примерами
YAML — самый распространённый формат конфигурационных файлов. Вот правила, которые нужны, чтобы читать и писать его без ошибок.
Открыть инструмент: Валидатор YAML
Основные элементы
| Элемент | YAML | Значение |
|---|---|---|
| Словарь | имя: web | Ключ со значением |
| Вложенный словарь | Дочерние ключи с отступом 2 пробела | Объект внутри объекта |
| Список | - первый элемент | Один элемент списка |
| Список в строку | [a, b, c] | Короткий список в одной строке |
| Комментарий | # заметка | Программы его игнорируют |
| Пустое значение | ~, null или ничего | Нет значения |
Многострочный текст
Символ | сохраняет переносы строк как есть — удобно для скриптов и сертификатов. Символ > склеивает строки в один абзац — удобно для длинных описаний. Добавьте - после символа (|- или >-), чтобы убрать последний перенос строки.
Якоря и несколько документов
- Напишите &имя перед значением, чтобы отметить его, и *имя позже, чтобы использовать повторно.
- Используйте <<: *имя, чтобы влить повторно используемый словарь в другой.
- Разделяйте несколько документов в файле строкой из трёх дефисов (---).
- Завершайте документ строкой ..., если инструменту нужен явный конец.