Skip to content

syntax.md

Latest commit

 

History

History
96 lines (78 loc) · 3.31 KB

syntax.md

File metadata and controls

96 lines (78 loc) · 3.31 KB

Синтаксис

Мы используем Markdown в нотации mdx, который позволяет расширить возможности разметки.

В верхней части каждого файла между знаками --- находится раздел front-matter. Про это надо просто знать, в документации приведены примеры этого раздела для каждого файла.

Список файлов для редактирования и перечень инструментов вы найдёте в файле README.md.

Используемые теги оформления

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

Заголовки

# Заголовок 1
## Заголовок 2
### Заголовок 3
#### Заголовок 4

По возможности, делайте как можно меньшую вложенность в статье. В большинстве случаев с лихвой хватает заголовков 1…2.

Абзацы

Текст разделяется на абзацы, если между блоками текста есть пустая строка:

Первый абзац текста.

Второй абзац текста.

Выделение текста

_курсив_
**жирный**
~~зачеркнутый~~

**это работает и с целым предложением**

При изменении текста в онлайн редакторе на Github работают горячие клавиши:

  • Ctrl+I — курсив
  • Ctrl+B — жирный.

Цитата

> Текст цитаты

Блок кода

Чтобы вывести вна странице код, надо заключить его в косые кавычки ``` (над буквой Ё).

```
function test() {
  console.log("текст");
}
```

Ссылка

[Заголовок внешней ссылки](https://URL)
[Заголовок относительной ссылки](/doc/components.md)

Картинка

Используйте компонент :photo.

Списки

Маркированный:

Заголовок списка:
- подпункт 1;
- подпункт 2.

Нумерованный:

Заголовок списка:
1. Пункт 1.
2. Пункт 2.

Вложенный:

Заголовок списка:
- пункт 1;
  - подпункт 1;
  - подпункт 2;
- пункт 2.

Дополнительные компоненты

Список компонентов для редакторов

Экранирование символов

Иногда нужно, чтобы введённые символы отображались «как есть» и не учитывались интерпретатором как символы разметки, сделать это можно добавив левый слеш перед символом:

Пример \*\*выражения между звездочками\*\*