Что такое Markdown
Markdown — язык разметки текстов. Такие тексты легко писать и читать. Их можно без труда сконвертировать в HTML. Большинство программистов предпочитают Markdown для написания документации, описаний своих проектов, написания блогов и так далее.
Что это значит?
«Язык разметки» — это просто набор соглашений, правил.
Допустим, что вы общаетесь с другом по СМС. В них нельзя сделать текст жирным или наклонным. Вы договариваетесь с другом: если я пишу *что-то*
вот так между звездочками, то считай, что это наклонный текст. А если я пишу **что-то**
между двумя звездочками, то считай, что это жирный текст. Вы придумали правила.
Markdown — это набор подобных правил.
Правила понятны разным программам и сайтам. Например, «Вопросы и ответы» в уроках на Хекслете поддерживают Markdown. Это значит, что вы можете писать туда тексты по правилам Markdown, а после нажатия «Отправить» разметка станет реальной: текст в одинарных звездочках станет наклонным, текст в двойных звездочках станет жирным и так далее. Это конвертация из Markdown в HTML.
Зачем это нужно?
- Для добавления разметки туда, где невозможна реальная разметка. Например, в простом текстовом файле или в тех же СМС, где невозможно выделение жирным, создание заголовков, выделение цитат и пр.
- Для более удобного написания текстов для последующей конвертации в HTML или другие форматы.
Синтаксис Markdown
Это краткий справочник основных элементов синтаксиса Markdown. Единого стандарта не существует и разные версии Markdown могут отличаться в деталях. Но базовые элементы из списка ниже поддерживаются во всех стандартах.
Выделение текста
*Этот текст будет наклонным (курсив)*
_Этот текст будет наклонным (курсив)_
**Этот текст будет жирным**
__Этот текст будет жирным__
_Можно **вставлять** один тип в другой_
Заголовки
# Это самый крупный заголовок, он превращается в тег <h1>
## <h2>
### <h3>
#### <h4>
##### <h5>
###### <h6>
Ссылки
https://hexlet.io — текст простой ссылки станет кликабельной ссылкой автоматически
Ссылкой можно сделать любой текст:
[Это ссылка на Хекслет](https://hexlet.io)
Цитата
> Это мудрая цитата
> Мудрого человека.
Картинки
![Это опциональный alt-текст](/assets/images/markdown/markdown.png)
Код
Для выделения кода (или любого неотформатированного текста) используются специальные символы — обратные тики: `
Иногда нужно добавить кусок кода `function(12);`
в обычную строчку текста.
А иногда нужно вставить целый блок кода:
```javascript
const func = (num) => {
if (num > 0) {
return num - 1;
}
return num + 1;
};
```
Списки
Непронумерованный список:
* Пункт
* Еще один пункт
* Подпункт
* Еще один подпункт
Пронумерованный список:
1. Пункт
1. Еще один пункт
1. Подпункт
1. Еще один подпункт
В пронумерованном списке можно использовать любые числа — это не важно. При конвертации в HTML или другой формат числа станут правильными и последовательными (1, 2, 3 и т.д.).
Дополнительно про Markdown
Рахим Давлеткалиев