README.ru.md

Типография

• Заголовок
• Навигация
• Разделитель
• Заголовок подраздела
• Контент
• Пример кода
• Списки
• Вкладки
• Уведомления
• Изображения

---

Заголовок

Название раздела является первым и обязательным элементом страницы.

# Title

Навигация

Если раздел большой, то его необходимо разбить на подразделы и создать навигационное меню.

Навигационное меню представляет собой список со ссылками на подраздел. У заголовков подраздела необходимо указать якорь.

- [Subtitle 1](#subtitle-1)
- [Subtitle 2](#subtitle-2)

Note

Для разделения слов в ссылках используется kebab-case.

Разделитель

После навигации (содержания) необходимо указать разделитель.

---

Заголовок подраздела

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

## Subtitle

Если используется Навигация, то необходимо перед заголовком добавить якорь:

<a name="anchor"></a>
## Subtitle

Для названия первого пункта чаще всего необходимо использовать название Основы, вместо похожих Начало, Введение и др.

<a name="basics"></a>
## Основы

Если описывается компонент, который наследуется от другого класса, и в навигации есть пункт Основы, то описание наследования пишем строго после этого пункта.

<a name="basics"></a>
## Основы

Наследует [Select](/docs/{{version}}/fields/select).

\* имеет те же возможности.

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

<a name="basics"></a>
## Основы

Содержит все [Базовые методы](/docs/{{version}}/fields/basic-methods).

Контент

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

Warning

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

Желательно построчно синхронизировать тексты в ru и en версиях разделов.

Для выделения имени собственного используются двойные звёздочки **, например, **MoonShine**.

Пример кода

• для оформления методов, классов и тд. используется одиночный апостроф `,
• названия методов должны заканчиваться скобками, например: setLabel(),
• для оформления блоков кода используется тройные апострофы ``` с указанием языка программирования и начинаться блок должен с новой строки,
• для всех классов, используемых в примерах, необходимо указать use в алфавитном порядке и обернуть их в collapse.

// torchlight! {"summaryCollapsedIndicator": "namespaces"}
// [tl! collapse:1]
use MoonShine\UI\Fields\Text;

Text::make('Title')

или

// torchlight! {"summaryCollapsedIndicator": "namespaces"}
// [tl! collapse:start]
use MoonShine\UI\Fields\Text; // [tl! collapse:end]

Text::make('Title')

Списки

- элементы списка заканчивается запятой,
- после последнего элемента ставится точка.

Вкладки

~~~tabs

tab: Tab 1
Content tab 1

tab: Tab 2
Content tab 2

~~~

Уведомления

В документации используется несколько типов уведомлений:

> [!NOTE]
> Простое уведомление.

> [!WARNING]
> Предупреждение.

> [!TIP]
> Советы.

Изображения

Изображения добавляем в директорию /resources/screenshots.

Ссылку указываем - https://raw.githubusercontent.com/moonshine-software/doc/3.x/resources/screenshots/filename.png

Пример: