Руководство по Markdown в документации AnviLink

Markdown — это простой язык разметки, который позволяет красиво оформлять документацию, не отвлекаясь на сложный HTML.

---

Недопустимый URL для встраивания. Используйте https-ссылку с YouTube, Vimeo, Rutube, anvilink.ru и других поддерживаемых сервисов.

1. Заголовки

Используйте # для заголовков разного уровня:

Заголовок H1

Заголовок H2

Заголовок H3

Заголовок H4

Заголовок H5

Заголовок H6

Код:

# Заголовок H1
## Заголовок H2
### Заголовок H3
#### Заголовок H4
##### Заголовок H5
###### Заголовок H6

---

2. Текстовое оформление

Вы можете комбинировать разные стили.

• Обычный текст.
• Жирный текст: **жирный**
• Курсив: *курсив*
• Жирный курсив: ***жирный курсив***
• Зачёркнутый: ~~зачёркнутый~~
• Подчёркивание: <u>подчёркнутый текст</u>
• Выделение «кода в строке» — например, команда npm install или метод User::find().

Код: жирный — **жирный**, курсив — *курсив*, код — `код`.

---

3. Списки

3.1 Маркированный список

• Первый пункт
• Второй пункт
  • Вложенный пункт 2.1
  • Вложенный пункт 2.2
• Третий пункт

Код:

- Первый пункт
- Второй пункт
  - Вложенный пункт 2.1
- Третий пункт

3.2 Нумерованный список

1. Шаг первый
2. Шаг второй
3. Шаг третий
   1. Подшаг 3.1
   2. Подшаг 3.2

Код:

1. Шаг первый
2. Шаг второй
3. Шаг третий
   1. Подшаг 3.1
   2. Подшаг 3.2

---

4. Цитаты

Это обычная цитата одного уровня.

Ещё одна строка цитаты.

Цитата с заголовком

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

Код:

> Это обычная цитата одного уровня.
>
> Ещё одна строка цитаты.

> ### Цитата с заголовком
> Используется для выделения важных замечаний.

---

5. Код

5.1 Встроенный код

Используйте обратные апострофы: например, composer install, php artisan october:up.

Код: `команда` или `метод()`.

5.2 Блоки кода

# Установка зависимостей
composer install

# Применение миграций
php artisan october:up

<?php

use Tailor\Models\EntryRecord;

$articles = EntryRecord::inSection('KnowledgeBase')
    ->applyVisibleFrontend()
    ->get();

foreach ($articles as $article) {
    echo $article->title . PHP_EOL;
}

{
  "name": "anvilink-docs",
  "private": true,
  "scripts": {
    "build": "npm run production"
  }
}

Код: блок кода — тройные обратные кавычки и указание языка (для отображения вложенных блоков здесь использованы четыре кавычки):

```bash
composer install
```

```php
<?php
$articles = EntryRecord::inSection('KnowledgeBase')->get();
```

```json
{ "name": "project" }
```

---

6. Ссылки и изображения

Обычная ссылка:

• Главная документации AnviLink
• Страница авторизации

Рабочие изображения (примеры с внешнего CDN):

Код:

[Текст ссылки](https://example.com)
![Альт изображения](https://example.com/image.jpg "Подпись (title)")

---

7. Таблицы

Простая таблица статусов (с горизонтальной прокруткой при нехватке места):

Статус	Описание	Иконка
draft	Черновик, не виден пользователям	📝
published	Опубликован, доступен на сайте	✅
archived	Архив, доступен только в панели	📦

Код:

| Заголовок 1 | Заголовок 2 |
| ----------- | ----------- |
| Ячейка 1    | Ячейка 2    |

Широкая таблица (прокрутка по горизонтали):

Колонка A	Колонка B	Колонка C	Колонка D	Колонка E	Колонка F
Ячейка 1	Ячейка 2	Ячейка 3	Ячейка 4	Ячейка 5	Ячейка 6
Данные	Данные	Данные	Данные	Данные	Данные

Таблица «зебра»:

Тип доступа	Описание
public	Доступно всем
auth	Только авторизованным
groups	Только выбранным группам

Синтаксис:

<table class="table-zebra">
<thead>
<tr>
<th>Колонка</th>
<th>Колонка</th>
</tr>
</thead>
<tbody>
<tr>
<td>Ячейка</td>
<td>Ячейка</td>
</tr>
</tbody>
</table>

---

8. Горизонтальные линии

Используйте --- или *** для разделения логических блоков:

---

Этот текст уже под линией-разделителем.

---

И ещё один раздел.

Код: три дефиса или звёздочки: --- или ***.

---

9. Списки задач (todo)

Можно использовать чекбоксы, если это удобно:

• [x] Настроить Tailor для статей
• [x] Включить Markdown-редактор
• [ ] Заполнить все разделы документации
• [ ] Добавить примеры кода для API

Код:

- [x] Выполненный пункт
- [ ] Невыполненный пункт

---

10. Плашки, спойлер и вкладки

Расширенный синтаксис AnviLink (блоки ::: … :::), без HTML.

Плашка с иконкой:

Спойлер:

Нажмите, чтобы раскрыть спойлер

Скрытый текст или дополнительная информация.

Вкладки:

Справка по синтаксису:

Элемент	Синтаксис
Плашка	::: note / tip / warn / danger … :::
Иконка в плашке	первая строка @icon ph ph-info
Спойлер	::: spoiler Заголовок … :::
Вкладки	::: tabs + @tab Название … :::
Таблица-зебра	::: zebra + markdown-таблица … :::
Подчёркивание	<u>текст</u>

---

11. Комбинации элементов

Иногда полезно комбинировать разные элементы в одном блоке.

Важно: перед тем как публиковать изменения:

1. Убедитесь, что все ссылки рабочие.
2. Проверьте форматирование кода:

   php artisan october:util compile assets

3. Посмотрите страницу в светлой и тёмной теме.

---

12. Пример структурированного раздела документации

12.1 Обзор

В этом разделе показано, как использовать Markdown в базе знаний AnviLink для написания:

• руководств,
• туториалов,
• описаний API.

1. Регистрация в Prismic

   Перейдите на страницу регистрации и заполните форму.

   • Email
   • Пароль

   

   

   1 / 2

   Можно войти через сторонний аккаунт.

2. Подтвердите email

   Проверьте почту и перейдите по ссылке из письма.

3. Заполните профиль

   Укажите имя и аватар — их увидят другие редакторы.