Docs

Работа с MarkDown

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

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

1. Заголовки

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

Заголовок H1

Заголовок H2

Заголовок H3

Заголовок H4

Заголовок H5
Заголовок H6

Код:

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

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

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

  • Обычный текст.
  • Жирный текст: **жирный**
  • Курсив: *курсив*
  • Жирный курсив: ***жирный курсив***
  • Зачёркнутый: ~~зачёркнутый~~
  • Подчёркивание (через HTML): <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. Ссылки и изображения

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

Рабочие изображения (примеры с внешнего 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
Данные Данные Данные Данные Данные Данные

Таблица в стиле «зебра» (чередование строк; в Markdown используйте HTML с классом table-zebra):

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

Код: зебра — HTML с классом table-zebra:

<table class="table-zebra">
<thead><tr><th>Колонка</th></tr></thead>
<tbody>
<tr><td>Строка 1</td></tr>
<tr><td>Строка 2</td></tr>
</tbody>
</table>

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

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

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

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

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

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

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

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

Код:

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

10. Плашки-уведомления и спойлер

Плашки (hints) — через HTML с классами callout callout-note, callout-tip, callout-warn, callout-danger. Можно добавить иконку ph вместо или вместе с текстом (первый элемент с классом callout-icon):

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

Код: плашки — HTML с классами callout callout-note (или callout-tip, callout-warn, callout-danger), внутри — callout-icon и callout-body.

Спойлер (раскрывающийся блок)

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

Скрытый текст или дополнительная информация. Поддерживается браузерами без JavaScript.

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

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

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

  1. Убедитесь, что все ссылки рабочие.
  2. Проверьте форматирование кода:
    php artisan october:util compile assets
  3. Посмотрите страницу в светлой и тёмной теме.

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

12.1 Обзор

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

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

12.2 Мини‑шпаргалка

# Заголовок

Текст, **жирный**, *курсив*, `код`.

- Список
- Ещё пункт

> Цитата

```php
// Блок кода


---

## 13. Итог

Markdown даёт:

- **контроль над разметкой** без тяжёлых визуальных редакторов;
- удобство хранения в Git (понятные diff’ы);
- единый стиль документации.

Используйте этот пример как шаблон при создании новых статей в базе знаний AnviLink.

Последнее изменение: 16.03.2026 14:09

Предыдущая —
Следующая —