Изучаем Markdown

Markdown - инструмент, с помощью которой вы сможете красиво оформить страницу вашего проекта на GitHub. Прочитав эту статью вы выучите Markdown и сможете его использовать.

Что такое Markdown?

Markdown - облегчённый язык разметки преднозначенный для форматирования текстовых документов. Markdown-файлы без потерь преобразуются в другие форматы (например, HTML и PDF), открываются в любом текстовом редакторе и будут понятны любым человеком даже в виде исходного кода.

В сравнении с HTML, данный язык гораздо проще и быстрее можно выучить. Что же, давайте начнем!

Где используется Markdown?

Чаще всего Markdown используют именно программисты:

• README файлы на GitHub
• Страницы на сайте технической документации Microsoft Learn
• Оформление постов и коментариев на сайтах, таких как:
• Хабр
• Stack Overflow
• Stack Exchange

Но также он может использоавться не програмистами:

• Посты и коментарии на Reddit
• Создание личных заметок в специальных приложениях (например, в Obsidian)
• Форматирование текста на личном сайте или блоге
• Оформление сообщений в Discord или Telegram
• Оформление электронных писем.

Как писать на Markdown?

Чтобы оформить текст на Markdown, нужно расставить по нему специальные символы - указатели. Затем интерпретатор переведёт файл в нужный формат (например в HTML) и у вас в руках окажется готовый симпатичный документ.

Синтаксис Markdown

Теперь же, давайте начнём изучение данного языка. Писать markdwon документы можно на сайте Markdown-editor

1. Заголовки

Для создания заголовков в Markdown используется символ #. Чем больше данных символов вы напечатали перед тектом, тем ниже будет уровень заголовка.

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

2. Праграфы

Чтобы создать параграф просто напишите текст без каких либо дополнительных указателей:

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

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

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

Для того, чтобы как либо выделить текст, используйте указатели:

• Курсив: один символ * или _
• Жирный текст: два символа * или _
• Жирный курсив: три символа * или _
• Зачеркнутый текст: два символа ~

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

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

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

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

4. Списки

Бывают 3х видов и создаются практически одинаково.

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

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

Маркированный список. Добавьте символ - перед текстом

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

Вложенный список. Добавьте 4 пробела перед пунктом

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

5. Цитаты

Для создания блоков цитат используйте символ >:

> Это простая цитата
> Многострочная цитата
>> Вложенная цитата

6. Блоки кода

Для вставки кода используйте обратные апострофы (```). Для подсветки синтаксиса укажите имя языка программирования:

```python
def hello():
    print("Hello, Markdown!")
```

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

`sudo apt install python3`

7. Ссылки

Несколько способов создания ссылок:

[Текст ссылки](https://example.com)
[Якорная ссылка][1]
[1]: https://example.com "Подсказка"

8. Изображения

Синтаксис похож на ссылки, но с восклицательным знаком в начале:

![Альтернативный текст](image.jpg)
![Лого][logo]
[logo]: logo.png "Логотип"

В квадратных скобках мы указываем аальтернативный текст (он отобразится, если файл изображения будет утерян), а в круглых указываем ссылку на изображение или GIF файл

9. Таблицы

Создавайте таблицы с помощью вертикальных линий:

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

10. Горизонтальные линии (разделители)

Три или более дефиса, звёздочки или подчёркивания:

---
***
___

11. Чек-листы

Используйте вот этот код:

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

Для обозначения задачи как выполненной используйте X, а для не выполненной просто пробел.

12. HTML-вставки

Markdown поддерживает прямую вставку HTML:

<div class="warning">
    Это HTML-блок
</div>

Заключение

Думаю, что у вас получилось разобраться с Markdown ведь его синтаксис и в правду учится очень быстро. Теперь вы можете красиво оформить ваши заметки, создать оформленную страницу на GitHub или просто сделать сообщение в Discord более привлекательным и читабельным.