md-syntax.md

Синтаксис Extended Markdown

Заголовки

# Заголовок уровня 1
## Заголовок уровня 2
### Заголовок уровня 3
#### Заголовок уровня 4
##### Заголовок уровня 5
###### Заголовок уровня 6

Параграфы

Параграфы фармируются пустой строкой

Между предложениями

Разрыв строки

Текст первой строки.<br> Текст второй строки

Форматирование текста

Я люблю **жирный текст**.
Я люблю *курсивный текст*.
Я люблю ~~зачеркнутый текст~~

Цитаты

> Здесь написана цитата

Списки

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

1. First item
2. Second item
3. Third item
4. Fourth item

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

- First item
- Second item
- Third item
- Fourth item

Можно так же вкладывать список в список

Изображения

![Альтернативный текст](./assets/vkcloud.png)

Ссылки

Относительная внутренняя ссылка (рекомендуется ссылок на страницы внутри документации)
[Видимый текст ссылки](../pagename)

Внешняя ссылка
[Видимый текст ссылки](https://github.com/vk-cs/docs-public)

Ссылка на файл (будет отмечена иконкой, клик по ссылке приведет к скачиванию) [Скачать картинку](https://github.com/vk-cs/docs-public/img.png "download")

Блоки с кодом

Пример подсветки кода для языка JavaScript

```js
console.log('Работающий код')
```

Список поддерживаемых языков тут.

Таблицы

Обычная таблица (не следует делать слишком много колонок)

| Синтаксис      | Описание       |
| ---            | ---            |
| Текст 1        | Текст 3        |
| Текст 2        | Текст 4        |

Таблица с выравниванием внутри колонок

| Синтаксис      | Описание       | Заголовок     |
| :---           | :----:         | ---:          |
| Текст слева    | Текст в центре | Текст справа  |
| Текст 1        | Текст 2        | Текст 3       |

Табы

Чтобы добавить на страницу табы, нужно использовать HTML-разметку и разметить контент следующим образом:

<tabs>
<tablist>
<tab>Tab 1</tab>
<tab>Tab 2</tab>
</tablist>
<tabpanel>

*Tab 1 description*

| Tab 1 table header 1 | Tab 1 table header 2 |
| --- | --- |
| Tab 1 table content 1 | Tab 1 table content 2 |

</tabpanel>
<tabpanel>

Tab 2 content

</tabpanel>
</tabs>

Порядок tabpanel должен повторять порядок tab. Внутри тегов можно размещать markdown. Для работы markdown внутри тегов необходимо отделять markdown от тегов пустой строкой.

Инфоблоки

Есть 3 типа инфоблоков: info, warn, err

<info>
Инфоблок с серым цветом фона
</info>

<warn>
Инфоблок с желтым цветом фона
</warn>

<err>
Инфоблок с красным цветом фона
</err>

Генерация из swagger-файла

Существует возможность сгенерировать страницу документации из swagger-файла указав (ищите примеры в документации)

![{swagger}](./assets/registry.swagger.json)

Символы, которые требуется экранировать

\	 backslash
`	 backtick (see also escaping backticks in code)
*	 asterisk
_	 underscore
{ }	 curly braces
[ ]	 brackets
< >	 angle brackets
( )	 parentheses
#	 pound sign
+	 plus sign
-	 minus sign (hyphen)
.	 dot
!	 exclamation mark
|	 pipe (see also escaping pipe in tables)

Встраивание HTML

Возможно встраивать любую html разметку, но это крайне не привествуется.