Руководство по оформлению Markdown файлов

Markdown - это облегчённый язык разметки, который преобразует текст в структурированный HTML. Следующее руководство поможет вам разобраться, как использовать Markdown.

Заголовки

1
2
3
4
5
6

# Заголовок первого уровня
## Заголовок второго уровня
### Заголовок третьего уровня
#### Заголовок четвёртого уровня
##### Заголовок пятого уровня
###### Заголовок шестого уровня

Пример:

Заголовок первого уровня

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

Заголовок третьего уровня

Заголовок четвёртого уровня

Заголовок пятого уровня
Заголовок шестого уровня

Параграфы и переносы строк

1
2
3
4

Это параграф. Чтобы создать новый параграф, оставьте пустую строку между двумя строками текста.

Это первая строка  
И это вторая строка, но они находятся в одном параграфе. Для переноса строки используйте два пробела в конце предыдущей строки.

Пример:

Это параграф. Чтобы создать новый параграф, оставьте пустую строку между двумя строками текста.

Это первая строка
И это вторая строка, но они находятся в одном параграфе. Для переноса строки используйте два пробела в конце предыдущей строки.

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

*курсив*  
_курсив_

**жирный**  
__жирный__

***жирный курсив***  
___жирный курсив___

~зачеркнутый~~

Пример:

курсив
курсив

жирный
жирный

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

зачеркнутый~

Списки

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

1
2
3

1. Пункт первый
2. Пункт второй
3. Пункт третий

Пример:

  1. Пункт первый
  2. Пункт второй
  3. Пункт третий

Маркированный список

1
2
3

- Пункт первый
- Пункт второй
- Пункт третий

Пример:

  • Пункт первый
  • Пункт второй
  • Пункт третий

Вложенные списки

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

1
2
3
4

1. Пункт первый
    - Подпункт первый
    - Подпункт второй
2. Пункт второй

Пример:

  1. Пункт первый
    • Подпункт первый
    • Подпункт второй
  2. Пункт второй

Ссылки

1

[Текст ссылки](https://www.example.com)

Пример:

Текст ссылки

Изображения

1

![Текст описания](https://www.example.com/image.jpg)

Пример:

Текст описания

Блоки кода

Строка кода

1

`строка кода`

Пример:

строка кода

Блок кода

Удалите символы \

1
2
3

\```
Блок кода
\```

Пример:

1

Блок кода

Подсветка кода

Для блоков кода можно указывать язык программирования.

Используется подсветка синтаксиса из библиотеки linguist, которая включает множество различных языков.

Удалите символы \

1
2
3

\```python
print("Привет, мир!")
\```

Пример:

1

print("Привет, мир!")

Цитаты

1
2
3

> Первый уровень цитирования
>> Второй уровень цитирования
>>> Третий уровень цитирования

Пример:

Первый уровень цитирования

Второй уровень цитирования

Третий уровень цитирования

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

1

---

Пример:

Таблицы

1
2
3
4

| Заголовок 1 | Заголовок 2 |
| ----------- | ----------- |
| Ячейка 1    | Ячейка 2   |
| Ячейка 3    | Ячейка 4   |

Пример:

Заголовок 1Заголовок 2
Ячейка 1Ячейка 2
Ячейка 3Ячейка 4

Таблица как HTML

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

<table>
    <tr>
        <th>Заголовок 1</th>
        <th>Заголовок 2</th>
    </tr>
    <tr>
        <td>Ячейка 1.1</td>
        <td>Ячейка 2.1</td>
    </tr>
    <tr>
        <td>Ячейка 1.2</td>
        <td>Ячейка 2.2</td>
    </tr>
</table>

Пример:

Заголовок 1Заголовок 2
Ячейка 1.1Ячейка 2.1
Ячейка 1.2Ячейка 2.2

Чек-листы

1
2
3

- [x] Задача 1
- [ ] Задача 2
- [ ] Задача 3

Пример:

  • Задача 1
  • Задача 2
  • Задача 3

Внутренние ссылки

1
2
3
4

[Перейти к Заголовку 1](#title1)

## <a id="title1">Заголовок 1</a>
Какой-то контент

Пример:

Перейти к Заголовку 1

Заголовок 1

Какой-то контент

Ссылка на заголовок на английском

1
2
3
4

[Some title 1](#some-title-1)

## Some Title 1
Some content

Пример:

Some title 1

Some Title 1

Some content

Автоматические ссылки

1
2
3

<http://example.com/>

<address@example.com>

Пример

http://example.com/

address@example.com

HTML

Markdown поддерживает использование прямого HTML внутри документа, так что вы можете использовать любые HTML-теги для более сложного оформления:

1

<kbd>CTRL</kbd> + <kbd>P</kbd>

Пример:

CTRL + P

HTML-коды

Например, вы можете использовать HTML-код &macr; для добавления черты над буквой:

1

A&macr;

Пример:

A¯

Комментарии

Вы можете вставить комментарии в свой markdown-файл, которые не будут отображаться в окончательном отформатированном виде:

1

[//]: # (Это комментарий, он не будет отображаться)

Пример:

Эмодзи (Github)

Вы можете использовать эмодзи в своих Markdown-файлах. Существует множество эмодзи, которые вы можете использовать, вот некоторые из них:

1
2
3

:smile:
:laughing:
:blush:

Пример:

:smile: :laughing: :blush: