Руководство по Markdown

Краткий справочник по синтаксису Markdown в заметках PlainApp — заголовки, списки, таблицы, блоки кода и другое.

Заголовки

Добавьте # в начало строки — количество # задаёт уровень от 1 (самый крупный) до 6 (самый мелкий). Оставляйте пустую строку до и после заголовка.

Markdown
# Heading level 1
## Heading level 2
### Heading level 3
#### Heading level 4
##### Heading level 5
###### Heading level 6
Результат

Heading level 1

Heading level 2

Heading level 3

Heading level 4

Heading level 5
Heading level 6

Совет: Кнопка «Заголовок» на панели редактора PlainApp вставляет их автоматически.

Абзацы и переносы строк

Разделяйте абзацы пустой строкой. Чтобы разбить строку внутри абзаца, поставьте в её конце обратную косую черту.

Markdown
First paragraph.

Second paragraph.
Результат

First paragraph.

Second paragraph.

Markdown
Line one\
Line two
Результат

Line one
Line two

Жирный и курсив

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

Markdown
**bold text**
Результат

bold text

Markdown
*italic text*
Результат

italic text

Markdown
~~struck through~~
Результат

struck through

Markdown
**bold and *nested italic***
Результат

bold and nested italic

Списки

Начните строку с - для маркированного списка или 1. для нумерованного. Отступ пробелами создаёт вложенность. Используйте - [ ] для задачи и - [x], когда она выполнена.

Markdown
- One
- Two
- Three
Результат
  • One
  • Two
  • Three
Markdown
1. First
2. Second
3. Third
Результат
  1. First
  2. Second
  3. Third
Markdown
- [ ] Buy milk
- [x] Write the note
Результат
  • Buy milk
  • Write the note
Markdown
- Fruit
  - Apple
  - Banana
- Vegetable
Результат
  • Fruit
    • Apple
    • Banana
  • Vegetable

Цитаты и выноски

Начните строку с > для цитаты. В PlainApp > [!note] превращает блок в выноску.

Markdown
> This is a blockquote.
Результат

This is a blockquote.

Markdown
> [!note] Heads up
> This renders as a callout box in PlainApp.
Результат

[!note] Heads up This renders as a callout box in PlainApp.

Код

Встроенный код оберните одиночными обратными кавычками. Для блока кода используйте тройные и укажите язык — подсветка включится автоматически.

Markdown
Use `inline code` for short snippets.
Результат

Use inline code for short snippets.

Markdown
```js
console.log("hello");
```
Результат
console.log("hello");

Совет: Кнопка «Код» на панели редактора вставляет встроенный код и блоки кода.

Изображения

Как ссылка, но с восклицательным знаком впереди: ![альтернативный текст](URL изображения).

Markdown
![PlainApp logo](/plainapp.svg)
Результат

PlainApp logo

Таблицы

Стройте таблицу вертикальными чертами

Markdown
| Left | Center | Right |
|:-----|:------:|------:|
| a    | b      | c     |
| d    | e      | f     |
Результат
Left Center Right
a b c
d e f

Совет: Кнопка «Таблица» на панели редактора вставляет пустой каркас таблицы.

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

Три и более дефисов, звёздочек или подчёркиваний в отдельной строке создают разделитель. Оставьте пустую строку выше, иначе предыдущая строка станет заголовком.

Markdown
First section.

---

Second section.
Результат

First section.


Second section.

Экранирование

Поставьте обратную косую черту перед символами, которые Markdown иначе отформатирует: * _ # или обратная кавычка.

Markdown
\*not italic\*
Результат

*not italic*

Markdown
\# not a heading
Результат

# not a heading

Встроенный HTML

PlainApp также отображает в заметках несколько HTML-тегов: подчёркивание, выделение, цветной текст и раскрывающиеся details.

Markdown
<u>underlined text</u>
Результат

underlined text

Markdown
<mark>highlighted text</mark>
Результат

highlighted text

Markdown
<font color="#8b5cf6">colored text</font>
Результат

colored text

Markdown
<details>
<summary>Click to expand</summary>
Hidden content here.
</details>
Результат
Click to expand Hidden content here.

Математика и другое

Верхний индекс x^2^, нижний H~2~O, встроенные формулы $E = mc^2$, блоки формул с $$, сноски [^1] и %% комментарии %%, скрытые в заметке.

Markdown
x^2^ + y^3^
Результат

x^2^ + y^3^

Markdown
H~2~O
Результат

H2O

Markdown
Inline math $E = mc^2$ and a block:
$$
a^2 + b^2 = c^2
$$
Результат

Inline math $E = mc^2$ and a block: $$ a^2 + b^2 = c^2 $$

Markdown
See the footnote[^1] for details.

[^1]: This is the footnote text.
Результат

See the footnote[^1] for details.

[^1]: This is the footnote text.

Markdown
%% This comment stays hidden in PlainApp %%
Результат

%% This comment stays hidden in PlainApp %%

Совет: В заметках PlainApp формулы, сноски и выноски отображаются как богатые блоки; столбец «Результат» здесь показывает обычный веб-вывод.