Списки и цитаты
Списки помогают показать набор или последовательность действий, а цитата отделяет точную внешнюю формулировку от авторского текста.
Общий пример
- Проверьте конфигурацию.
- Соберите документацию.
- Откройте готовую страницу.
Хорошая документация помогает выполнить задачу.
Виды списков
Используйте маркированный список, когда порядок не важен:
- краткое назначение;
- допустимые параметры;
- полезные ограничения.
Нумерованный список подходит для последовательности:
- Подготовьте Markdown.
- Запустите сборку.
- Проверьте ссылки и внешний вид.
Вложенные пункты отделяют детали, но не должны превращать страницу в сложное дерево.
Цитата и источник
Сначала определите задачу читателя, а затем объясняйте устройство системы.
> Сначала определите задачу читателя, а затем объясняйте устройство системы.
{author="Автор материала" source="Название источника" url="https://example.com/source"}
Параметр author называет автора, source — публикацию, а url добавляет
безопасную ссылку. Не заполняйте неизвестные реквизиты заглушками: обычная
цитата без подписи полезнее выдуманного источника.