Шпаргалка по markdown разметке

Составил для себя небольшую шпаргалку по наиболее часто используемой Markdown-разметке.

Markdown — это легкий язык разметки, который используется:

• на GitHub;
• в README.md;
• в Telegram;
• в документации;
• в блогах;
• в системах заметок.

Ссылки в Markdown

Синтаксис ссылки:

[Текст ссылки](https://site.ru)

Пример:

[Статья про Telegram бота](http://nikovit.ru/blog/pishem-bota-peresylki-soobshcheniy-iz-vk-v-telegram-na-python/)

Результат:

Статья про Telegram бота

Код в Markdown

Блок кода выделяется:

• тремя обратными апострофами.

Пример:

```javascript
var s = "Подсветка JavaScript";
alert(s);
```

После указания языка:

javascript

многие редакторы автоматически включают:

• подсветку синтаксиса.

Цитаты в Markdown

Для цитат используется символ:

>

Пример:

> С помощью цитат очень удобно в письме обозначать исходный текст.
> Эта строка — часть той же цитаты.

Результат:

С помощью цитат очень удобно в письме обозначать исходный текст. Эта строка — часть той же цитаты.

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

Для создания разделительной линии:

--------------------------------------------

Или короткий вариант:

---

Результат:

Дополнительные полезные элементы Markdown

Заголовки

Заголовки создаются через символ:

#

Пример:

# Заголовок H1
## Заголовок H2
### Заголовок H3

Жирный текст

**Жирный текст**

Результат:

Жирный текст

Курсив

*Курсив*

Результат:

Курсив

Списки

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

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

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

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

Для чего удобно использовать Markdown

Markdown отлично подходит:

• для документации проектов;
• README файлов;
• заметок разработчика;
• технических инструкций;
• быстрого форматирования текста.

Итог

Markdown — очень простая, но при этом мощная разметка.

Нескольких базовых конструкций уже хватает для оформления:

• документации;
• инструкций;
• статей;
• README.md файлов на GitHub.