Что такое Markdown?

Markdown — это лёгкий язык разметки, позволяющий форматировать обычный текст — заголовки, списки, ссылки, выделение — с помощью простых и читаемых символов. Он широко используется для README, документации и заметок.

Как написать блок кода в Markdown?

Оберните код тремя обратными кавычками (```) на отдельных строках, при желании указав имя языка после открывающей строки для подсветки синтаксиса.

Markdown работает одинаково везде?

Базовый синтаксис единообразен, но диалекты различаются. GitHub Flavored Markdown добавляет к стандартному Markdown таблицы, списки задач и зачёркивание.

ШПАРГАЛКА

Гид по Markdown

Всё необходимое для письма в Markdown: каждый элемент синтаксиса показан с исходным кодом слева и результатом справа.

Заголовки

Шесть уровней заголовков, от крупного к мелкому, с помощью символа #.

Markdown

# Titre 1
## Titre 2
### Titre 3
#### Titre 4
##### Titre 5
###### Titre 6

Результат

Titre 1

Titre 2

Titre 3

Titre 4

Titre 5

Titre 6

Markdown

Titre 1 (syntaxe alternative)
===

Titre 2 (syntaxe alternative)
---

Результат

Titre 1 (syntaxe alternative)

Titre 2 (syntaxe alternative)

Абзацы

Разделяйте абзацы пустой строкой и при необходимости делайте перенос строки.

Markdown

Un paragraphe est un bloc de texte.

Une ligne vide sépare deux paragraphes.

Результат

Un paragraphe est un bloc de texte.

Une ligne vide sépare deux paragraphes.

Markdown

Terminez une ligne par deux espaces␣␣
pour forcer un saut de ligne.

Ou utilisez une barre oblique inverse\
en fin de ligne.

Результат

Terminez une ligne par deux espaces
pour forcer un saut de ligne.

Ou utilisez une barre oblique inverse
en fin de ligne.

Выделение

Делайте текст жирным, курсивным или зачёркнутым.

Markdown

*italique* ou _italique_
**gras** ou __gras__
***gras et italique***
~~barré~~

Результат

italique ou italique
gras ou gras
gras et italique
~~barré~~

Цитаты

Цитируйте текст на одну или несколько строк и вкладывайте цитаты друг в друга.

Markdown

> Une citation simple.
>
> Sur plusieurs lignes.

Результат

Une citation simple.
Sur plusieurs lignes.

Markdown

> Citation
>> Citation imbriquée
>>> Encore plus profond

Результат

Citation
Citation imbriquée
Encore plus profond

Списки

Маркированные, нумерованные, вложенные списки и списки задач.

Markdown

- Premier élément
- Deuxième élément
- Troisième élément

* Fonctionne aussi avec *
+ ou avec +

Результат

Premier élément
Deuxième élément
Troisième élément

Fonctionne aussi avec *
ou avec +

Markdown

1. Premier
2. Deuxième
3. Troisième

Результат

Premier
Deuxième
Troisième

Markdown

- Élément parent
  - Sous-élément
    - Sous-sous-élément
- Retour au parent

Результат

Élément parent
- Sous-élément
  - Sous-sous-élément
Retour au parent

Markdown

- [x] Tâche terminée
- [ ] Tâche à faire
- [ ] Autre tâche

Результат

Tâche terminée
Tâche à faire
Autre tâche

Код

Код в строке, блоки кода и подсветка синтаксиса по языку.

Markdown

Utilisez `code en ligne` dans une phrase.

Результат

Utilisez code en ligne dans une phrase.

Markdown

```
Bloc de code sans coloration
sur plusieurs lignes
```

Результат

Bloc de code sans coloration
sur plusieurs lignes

Markdown

```js
function salut(nom) {
  return `Bonjour ${nom}`;
}
```

Результат

function salut(nom) {
  return `Bonjour ${nom}`;
}

Ссылки

Простые ссылки, ссылки с подсказкой, автоссылки и ссылки по ссылке.

Markdown

[Texte du lien](https://exemple.com)
[Avec une infobulle](https://exemple.com "Titre au survol")

Результат

Texte du lien
Avec une infobulle

Markdown

Lien automatique : <https://exemple.com>

Lien de référence : [le texte][1]

[1]: https://exemple.com

Результат

Lien automatique : https://exemple.com

Lien de référence : le texte

Изображения

Вставляйте изображения с альтернативным текстом, заголовком или кликабельной ссылкой.

Markdown

![Texte alternatif](image.png)
![Avec titre](image.png "Titre au survol")

Результат

Markdown

Une image cliquable :

[![Alt](image.png)](https://exemple.com)

Результат

Une image cliquable :

Таблицы

Создавайте таблицы и выравнивайте столбцы влево, по центру или вправо.

Markdown

| Nom   | Rôle      | Score |
| ----- | --------- | ----- |
| Alice | Admin     | 95    |
| Bob   | Éditeur   | 82    |

Результат

Nom	Rôle	Score
Alice	Admin	95
Bob	Éditeur	82

Markdown

| Gauche | Centré | Droite |
| :----- | :----: | -----: |
| a      |   b    |      c |
| dd     |   ee   |     ff |

Результат

Gauche	Centré	Droite
a	b	c
dd	ee	ff

Горизонтальные линии

Разделяйте разделы горизонтальной линией.

Markdown

Trois tirets, astérisques ou underscores :

---

***

___

Результат

Trois tirets, astérisques ou underscores :

Экранирование

Показывайте специальные символы буквально, а не как разметку.

Markdown

\*Ceci n'est pas en italique\*
\# Ceci n'est pas un titre
\[Ceci n'est pas un lien\]

Результат

*Ceci n'est pas en italique*
# Ceci n'est pas un titre
[Ceci n'est pas un lien]

Расширенный Markdown

Сноски, эмодзи и встроенный HTML (в зависимости от движка).

Markdown

Voici une note de bas de page.[^1]

[^1]: Le contenu de la note.

Результат

Voici une note de bas de page.¹

Le contenu de la note. ↩

Markdown

Émoji par code : :tada: :rocket: :+1:

Émoji direct : 🎉 🚀 👍

Результат

Émoji par code : 🎉 🚀 👍

Émoji direct : 🎉 🚀 👍

Markdown

On peut aussi insérer du <mark>HTML</mark>
directement : <kbd>Ctrl</kbd> + <kbd>C</kbd>.

Результат

On peut aussi insérer du HTML directement : Ctrl + C.

Markdown — это стандарт, но некоторые элементы (таблицы, флажки, сноски, эмодзи) зависят от используемого движка рендеринга.

Об этом руководстве по Markdown

Наглядная шпаргалка по Markdown с примерами, охватывающая повседневный синтаксис: заголовки, полужирный и курсив, списки, ссылки, изображения, таблицы, блоки кода, цитаты и другое. Каждый пример показывает исходный Markdown рядом с отрендеренным результатом.

FAQ

Что такое Markdown?: Markdown — это лёгкий язык разметки, позволяющий форматировать обычный текст — заголовки, списки, ссылки, выделение — с помощью простых и читаемых символов. Он широко используется для README, документации и заметок.
Как написать блок кода в Markdown?: Оберните код тремя обратными кавычками (```) на отдельных строках, при желании указав имя языка после открывающей строки для подсветки синтаксиса.
Markdown работает одинаково везде?: Базовый синтаксис единообразен, но диалекты различаются. GitHub Flavored Markdown добавляет к стандартному Markdown таблицы, списки задач и зачёркивание.