Шпаргалка по Markdown
Полное справочное руководство по синтаксису Markdown
На основе спецификации GitHub Flavored Markdown (GFM) и CommonMark
Базовый синтаксис
Фундаментальные элементы оригинального Markdown
Заголовки (стиль ATX)
# Heading 1→Heading 1## Heading 2→Heading 2### Heading 3→Heading 3#### Heading 4→Heading 4##### Heading 5→Heading 5###### Heading 6→Heading 6Заголовки (стиль Setext)
Синтаксис
Heading 1 ========= Heading 2 ---------
Результат
Heading 1Heading 2
Выделение и форматирование
*italic*→italic_italic_→italic**bold**→bold__bold__→bold***bold italic***→bold italic~~strikethrough~~→Встроенный код
`code`→code``code with `backtick` ``→code with `backtick`Совет
Используйте двойные обратные кавычки, если ваш код содержит одинарные обратные кавычки.
Блоки кода (Fenced Code Blocks)
Синтаксис
```javascript
function greet(name) {
console.log(`Hello, ${name}!`);
}
greet("World");
```Результат
function greet(name) {
console.log(`Hello, ${name}!`);
}
greet("World");
console.log(`Hello, ${name}!`);
}
greet("World");
javascript
typescript
python
java
c
cpp
csharp
go
rust
ruby
php
swift
kotlin
scala
sql
bash
powershell
json
yaml
xml
html
css
scss
markdown
latex
r
matlab
perl
lua
haskell
elixir
clojure
dockerfile
nginx
apache
graphql
prisma
solidityСсылки
Ссылка-референс
[text][ref] [ref]: https://example.com "Title"
Изображения
Синтаксис
С заголовком
Изображение со ссылкой
[](link)
Ссылка
![Alt][ref] [ref]: url "Title"
Ненумерованные списки
Синтаксис
- Item 1
- Item 2
- Sub-item 2.1
- Sub-item 2.2
- Sub-sub-item
- Item 3
* Also works with *
+ And with +Результат
- Item 1
- Item 2
- Sub-item 2.1
- Sub-item 2.2
- Sub-sub-item
- Item 3
Нумерованные списки
Синтаксис
1. First item 2. Second item 1. Sub-item 2.1 2. Sub-item 2.2 3. Third item 1. Numbers don't need 1. to be in order 1. Markdown fixes it
Результат
- First item
- Second item
- Sub-item 2.1
- Sub-item 2.2
- Third item
Цитаты (Blockquotes)
Синтаксис
> This is a quote. > It can span multiple lines. > > > Quotes can be nested. > > Like this one. > > And continue after.
Результат
This is a quote. It can span multiple lines.Quotes can be nested. Like this one.And continue after.
Горизонтальные линии
Синтаксис
--- *** ___
Результат
Расширения GFM
Дополнительные возможности GitHub Flavored Markdown
Таблицы
Синтаксис
| Product | Price | Quantity | |------------|:------:|---------:| | Apple | $3 | 10 | | Banana | $2 | 25 | | Orange | $4 | 15 | Выравнивание: :--- слева :---: центр ---: справа
Результат
| Product | Price | Quantity |
|---|---|---|
| Apple | $3 | 10 |
| Banana | $2 | 25 |
| Orange | $4 | 15 |
Списки задач
Синтаксис
- [x] Completed task - [x] Another done task - [ ] Pending task - [ ] Another pending
Результат
- Completed task
- Another done task
- Pending task
- Another pending
Автоссылки
URL и email автоматически превращаются в ссылки
www.example.com https://example.com [email protected]
Оповещения/Callouts (GitHub)
Синтаксис
> [!NOTE] > Useful information that users > should know. > [!TIP] > Helpful advice for doing > things better or more easily. > [!IMPORTANT] > Key information users need > to know to succeed. > [!WARNING] > Urgent info that needs > immediate attention. > [!CAUTION] > Negative potential consequences > of certain actions.
Результат
NoteUseful information that users should know.
TipHelpful advice for doing things better.
ImportantKey information for success.
WarningCritical content needing attention.
CautionNegative consequences of certain actions.
Расширенный синтаксис
Продвинутые возможности, поддерживаемые некоторыми парсерами
Сноски
Синтаксис
Here's a sentence with
a footnote.[^1]
[^1]: This is the footnote.
You can also use text[^note].
[^note]: Notes can have
multiple lines.Результат
Here's a sentence with a footnote.[1]
You can also use text[note].
[1] This is the footnote.
[note] Notes can have multiple lines.
Списки определений
Синтаксис
Term 1 : Definition of term 1 Term 2 : Definition of term 2 : Second definition of term 2
Результат
- Term 1
- Definition of term 1
- Term 2
- Definition of term 2
- Second definition of term 2
Выделенный текст
==highlighted text==→highlighted textЗаметка
Поддерживается некоторыми парсерами, такими как Obsidian, Notion и другими.
Нижний и верхний индекс
H~2~O→H2OX^2^→X2HTML альтернатива
H<sub>2</sub>O X<sup>2</sup>
Аббревиатуры
Синтаксис
HTML is widely used on the web. *[HTML]: HyperText Markup Language
Результат
HTML is widely used on the web.
Математические формулы (LaTeX)
Встроенный
The formula $E = mc^2$ is famous.
Результат
The formula E = mc² is famous.
Блок
$$
\frac{n!}{k!(n-k)!} = \binom{n}{k}
$$Результат
n!k!(n-k)! = (nk)
HTML и специальные элементы
Использование inline HTML и специальных символов
Встроенный HTML
Поддерживаемые элементы
<kbd>Ctrl</kbd> + <kbd>C</kbd> <mark>Highlighted text</mark> <details> <summary>Click to expand</summary> Hidden content here. </details> <br> for line break
Результат
Ctrl + C
Highlighted text
Click to expand
Hidden content here.
Экранирование символов
Используйте \ перед специальными символами
\*text between asterisks\* \# not a heading \[not a link\] \\ backslash
Символы, которые можно экранировать
\ ` * _ { } [ ] ( ) # + - . ! |Переносы строк
Методы
Line 1 Line 2 (2 spaces at the end) Line 1<br> Line 2 (HTML tag) Line 1 Line 2 (blank line = paragraph)
HTML-сущности
©→©®→®™→™ →(неразрывный пробел)< >→< >&→&Продвинутые функции GitHub
Специфические возможности GitHub Flavored Markdown
Диаграммы Mermaid
Блок-схема
```mermaid
flowchart LR
A[Start] --> B{Decision}
B -->|Yes| C[Action 1]
B -->|No| D[Action 2]
C --> E[End]
D --> E
```Результат
Start
→Decision
Yes →
Action 1
No →
Action 2
End
Круговая диаграмма
```mermaid
pie title Distribution
"Movies" : 80
"Series" : 20
```Диаграмма последовательности
```mermaid
sequenceDiagram
Alice->>Bob: Hello Bob!
Bob-->>Alice: Hi Alice!
```
flowchartКлавиши клавиатуры (kbd)
Синтаксис
<kbd>Ctrl</kbd> + <kbd>C</kbd> <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> <kbd> Enter ↵ </kbd>
Результат
Ctrl + C
Cmd + Shift + P
Enter ↵
Сворачиваемые элементы
Синтаксис
<details> <summary>Click to expand</summary> Hidden content that will be revealed on click. - Item 1 - Item 2 - Item 3 </details>
Результат
Click to expand
Hidden content that will be revealed on click.
- Item 1
- Item 2
- Item 3
Упоминания и ссылки
Упоминания пользователей
@username @organization/team
Ссылки на Issue и PR
#123 GH-123 username/repo#123 organization/repo#123
Результат
@username — упоминает пользователя
#123 — ссылается на issue/PR #123
repo#456 — ссылается в другом репозитории
Цветовые модели
Синтаксис
`#ffffff` `#0969DA` `rgb(9, 105, 218)` `hsl(212, 92%, 45%)`
Результат
#ffffff#0969DArgb(9, 105, 218)hsl(212, 92%, 45%)Комментарии
Синтаксис
<!-- This is a comment --> <!-- Multi-line comment -->
Результат
(Комментарии невидимы в отрендеренном документе)
SHA коммитов
Синтаксис
a1b2c3d a1b2c3d4e5f6g7h8i9j0 username/repo@a1b2c3d
Результат
a1b2c3d — ссылка на коммитrepo@a1b2c3d — коммит в другом репозиторииКод с Diff
Синтаксис
```diff
- const old = "old value";
+ const new = "new value";
function unchanged() {
- return false;
+ return true;
}
```Результат
- const old = "old value";
+ const new = "new value";
function unchanged() {
- return false;
+ return true;
}
Якоря и внутренние ссылки
Создание якоря
<a name="section"></a> ## My Section
Ссылка на якорь
[Go to section](#section) [Back to top](#top)
Результат
Изображения с размером
Использование HTML
<img src="image.png" width="300">
<img src="image.png"
width="200"
height="100"
alt="Description">
<p align="center">
<img src="logo.png" width="150">
</p>Совет
Используйте HTML, когда нужно контролировать размеры или выравнивание изображений.
Оглавление
Синтаксис
## Table of Contents - [Introduction](#introduction) - [Installation](#installation) - [Requirements](#requirements) - [Setup](#setup) - [Usage](#usage) - [Contributing](#contributing)
Результат
Table of Contents
Badges/Shields
Синтаксис
 [](link) 
Результат
build: passingversion: 1.0.0license: MITdocs: latest
Выравнивание текста
Синтаксис
<div align="center"> Centered text </div> <div align="right"> Right-aligned text </div> <p align="center"> <strong>Centered bold</strong> </p>
Результат
Centered text
Right-aligned text
Centered bold
Инструменты и ресурсы
Полезные ссылки для работы с Markdown
Справочники и ресурсы
- GitHub Flavored Markdown Spec — Официальная спецификация GFM
- CommonMark — Стандартизированная спецификация Markdown
- Daring Fireball: Markdown Syntax — Оригинальная документация от John Gruber
- Markdown Guide — Полное справочное руководство
- Markdown Here Cheatsheet — Популярная шпаргалка сообщества
- Ultimate Markdown Cheatsheet — Полная шпаргалка на GitHub