К содержанию

Навигация

Списки и цитаты

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

Общий пример

  1. Проверьте конфигурацию.
  2. Соберите документацию.
  3. Откройте готовую страницу.

Хорошая документация помогает выполнить задачу.

Виды списков

Используйте маркированный список, когда порядок не важен:

  • краткое назначение;
  • допустимые параметры;
  • полезные ограничения.

Нумерованный список подходит для последовательности:

  1. Подготовьте Markdown.
  2. Запустите сборку.
  3. Проверьте ссылки и внешний вид.

Вложенные пункты отделяют детали, но не должны превращать страницу в сложное дерево.

Цитата и источник

Сначала определите задачу читателя, а затем объясняйте устройство системы.
Markdown
> Сначала определите задачу читателя, а затем объясняйте устройство системы.
{author="Автор материала" source="Название источника" url="https://example.com/source"}

Параметр author называет автора, source — публикацию, а url добавляет безопасную ссылку. Не заполняйте неизвестные реквизиты заглушками: обычная цитата без подписи полезнее выдуманного источника.

Поиск по документации

Введите минимум 2 символа

    Настройки

    Тема
    Размер шрифта
    Ширина страницы