Markdown

https://www.markdownguide.org/book

Базовый синтаксис

Описано в формате:

как выглядит

> как сделано

Заголовки

Заголовок 1 уровня

# Заголовок 1 уровня
Заголовок 6 уровня
###### Заголовок 6 уровня  

Заголовок 1 уровня (альтернативный способ)

Заголовок 1 уровня (альтернативный способ)  
===

Заголовок 2 уровня (альтернативный способ)

Заголовок 2 уровня (альтернативный способ)  
---

Выразительность

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

_Курсив_, __Жирный__, ___Жирный курсив___  

То же самое можно делать через *

 *Курсив*, **Жирный**, ***Жирный курсив***  

Цитаты

Цитата

> Цитата  

Многострочная цитата
Многострочная цитата
Многострочная цитата

> Многострочная цитата  
> Многострочная цитата  
> Многострочная цитата

Цитата

В цитате

> Цитата  
>> В цитате  

Вложенность может быть неограниченной


Списки

  1. Первый номерной элемент
  2. Второй
    1. Первый вложенный номерной элемент
    2. Второй
      • Первый вложенный непронумерованный элемент
      • Еще один
      • И еще один
  3. Пятый
1. Первый номерной элемент 
2. Второй  
   1. Первый вложенный номерной элемент  
   1. Второй  
      - Первый вложенный непронумерованный элемент  
      + Еще один  
      * И еще один
5. Пятый

Для вкладывания элементов нужно делать отступ в 4 пробела или одну табуляцию
Для пронумерованного списка не важно какие цифры используются, главное что цифры


Код

Код вставляется в "тики"

`Код вставляется в "тики"`

Если в коде уже используются тики, `например`, то можно использовать двойные тики

``Если в коде уже используются тики, `например`, то можно использовать двойные тики``

Блок кода можно сделать с помощью отступов (4 пробела или 1 табуляция), или можно воспользоваться тиками как в примере ниже

Через отступ
Вот так
Вот еще
    Через отступ # не отображаются пробелы, но перед буквой Ч стоит 4 пробела
```
Вот так
```
~~~
Вот еще
~~~

Горизонтальная линия




---
***
___

Как видно, все три варианта выглядят одинаково


Ссылки

Обычная ссылка
Ссылка с описанием
https://vandud.ru
Ссылка с форматированием

[Обычная ссылка](https://google.com)  
[Ссылка с описанием](https://google.com "Это ссылка на гугл")  
<https://vandud.ru>  
**[Ссылка с форматированием](https://google.com)**  

Картинки


![](https://i.ytimg.com/vi/rIwGkC8QjyM/hqdefault.jpg)  
![](https://i.ytimg.com/vi/rIwGkC8QjyM/hqdefault.jpg "Картинка с описанием")  

Расширенный синтаксис

Таблицы

Столбец 1 (дефолтное выравнивание) Столбец 2
Ячейка 1 Ячейка 2
... ...
| Столбец 1 | Столбец 2 |
| --- | --- |
| Ячейка 1 | Ячейка 2 |  
| ... | ... |
Таблица с выравниванием Второй столбец Третий столбец
Ячейка Ячейка Ячейка
Ячейка Ячейка Ячейка
| Таблица с выравниванием | Второй столбец | Третий столбец |
| :- | :-: | -: |
| Ячейка | Ячейка | Ячейка |
| Ячейка | Ячейка | Ячейка |
Таблица с форматированием Второй столбец Третий столбец
Курсив Жирный Жирный курсив
Ссылка на гугл Ячейка с кодом Сюда нечего вставить
| Таблица с форматированием | Второй столбец | Третий столбец |
| - | - | - |
| _Курсив_ | __Жирный__ | ___Жирный курсив___ |
| [Ссылка на гугл](https://google.com) | `Ячейка с кодом` | Сюда нечего вставить |  

В таблицу нельзя вставить:


Подсветка синтаксиса в блоках кода

import chtototam
for i in range(10):
  print(i)
{
"firstName": "John",
"lastName": "Smith",
"age": 256
}
```python
import chtototam
for i in range(10):
  print(i)
```
```json
{
"firstName": "John",
"lastName": "Smith",
"age": 256
}
```

Сноски

Here's a simple footnote, [^1] and here's a longer one. [^bignote]  

[^1]: This is the first footnote.  
[^bignote]: Here's one with multiple paragraphs and code.  
Indent paragraphs to include them in the footnote.  
`{ my code }`  
Add as many paragraphs as you like.

В моем редакторе они, к сожалению не работают, но в других выглядят примерно так

Screenshot-from-2019-10-08-16-05-19.png


Перечеркнутый текст

Strikethrough

~~Strikethrough~~  

Список задач

- [x] Task 1
- [ ] Task 2
- [x] Task 3

Collapse block

Можно сделать выпадашку
Делается так

# A collapsible section with markdown
<details>
  <summary>Click to expand!</summary>
  
  ## Heading
  1. A numbered
  2. list
     * With some
     * Sub bullets
</details>

Нужны пустые строки после </summary и после </details

С большим блоком кода (в несколько строк) у меня возникли проблемы, код не отображается как надо, поэтому вставил просто скриншот кода

Взял это все отсюда, там еще есть полезные комменты


Пример:

Click to expand!

Heading

  1. A numbered
  2. list
    • With some
    • Sub bullets