settings

Обзор

Страницы настроек должны сосредотачиваться исключительно на настройках и конфигурации устройства. Аппаратное обеспечение часто является связанной темой, однако эти страницы не должны пытаться объяснять подключение аппаратного обеспечения. Укажите, что аппаратное обеспечение требуется, и предоставьте ссылку на соответствующую(ие) страницу(ы).

Макет

Обзор

Этот раздел должен описывать группу настроек и их назначение для устройства.

Настройки

Этот раздел начинается с алфавитно отсортированной таблицы настроек, доступных значений и значений по умолчанию.

Доступные значения должны быть перечислены с обратными кавычками ` вокруг значения.

Тип значения Пример
Булево true, false
Список apple, banana, orange
Диапазон 0-100

После таблицы каждая настройка описывается кратко. Если доступные варианты для настройки требуют дополнительного объяснения, используйте таблицу для описания каждого доступного варианта.

Подробности

Если требуются дополнительные детали, этот необязательный раздел может их объяснить. Сюда входят предварительные требования, ссылки на руководства по аппаратному обеспечению и т. д.

Примеры

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

Пример шаблона

```markdown title="Template for Settings Pages"

id: unique-id title: Title for Page sidebar_label: Label for Sidebar


Overview

Settings

Setting Acceptable Values Default
my_setting_with_options apple, banana, orange apple

my_setting_with_options

Value Description
apple Description of apple (default)
banana Description of banana
orange Description of orange

CLI (Required for accessibility)

CLI content here

Android (Required for accessibility)

Android content here

iOS (Required for accessibility)

iOS content here

Web (Required for accessibility)

Web content here

Details

Examples

```