Шпаргалка по синтаксису Markdown: От новичка до эксперта

Введение

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

Базовые синтаксисы

Заголовки

Markdown поддерживает шесть уровней заголовков, используя символ #:

# Заголовок 1 уровня
## Заголовок 2 уровня
### Заголовок 3 уровня
#### Заголовок 4 уровня
##### Заголовок 5 уровня
###### Заголовок 6 уровня

Также можно использовать формат с подчёркиванием (только для 1 и 2 уровней):

Заголовок 1 уровня
========

Заголовок 2 уровня
--------

Абзацы и переносы строк

Абзацы должны разделяться пустой строкой. Если нужно перенести строку без создания нового абзаца, добавьте два пробела в конце строки.

Это первый абзац.

Это второй абзац.

Это одна строка  
Это следующая строка (обратите внимание на два пробела в конце предыдущей строки)

Форматирование текста

Эффект	Синтаксис	Пример
Полужирный	`текст` или `__текст__`	Полужирный текст
Курсив	`текст` или `_текст_`	Курсивный текст
Полужирный курсив	`*текст*` или `___текст___`	*Полужирный курсив*
Зачёркнутый	`~~текст~~`	~~Зачёркнутый текст~~
Подчёркнутый	`<u>текст</u>`	Подчёркнутый текст

Списки

Маркированные списки

Используйте -, + или * для создания маркированных списков:

- Пункт один
- Пункт два
  - Подпункт 2.1
  - Подпункт 2.2
- Пункт три

+ Можно также использовать плюс
* Или звёздочку

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

Используйте цифры с точкой для создания нумерованных списков:

1. Первый пункт
2. Второй пункт
   1. Подпункт 2.1
   2. Подпункт 2.2
3. Третий пункт

Списки задач

Списки задач в стиле GitHub:

- [x] Выполненная задача
- [ ] Невыполненная задача
- [ ] Ещё одна невыполненная задача

Ссылки

Строчные ссылки

[текст ссылки](https://www.example.com)
[ссылка с заголовком](https://www.example.com "заголовок ссылки")

Ссылки по ссылкам

[текст ссылки][ссылочный идентификатор]

[ссылочный идентификатор]: https://www.example.com "опциональный заголовок"

Автоматические ссылки

<https://www.example.com>
<[email protected]>

Изображения

![альтернативный текст](URL изображения)
![изображение с заголовком](URL изображения "заголовок изображения")

Ссылочные изображения:
![альтернативный текст][ссылка на изображение]

[ссылка на изображение]: URL изображения "опциональный заголовок"

Цитаты

> Это цитата
> Может занимать несколько строк
> 
> > И может быть вложенной

Код

Строчный код

Используйте `обратные кавычки` для строчного кода

Блоки кода

Используйте три обратные кавычки или отступ четыре пробела:

```javascript
function hello() {
    console.log("Hello, World!");
}
```

    Или с помощью отступа (четыре пробела)
    function hello() {
        console.log("Hello, World!");
    }

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

Используйте три или больше дефисов, звёздочек или подчёркиваний:

---
***
___

Продвинутые синтаксисы

Таблицы

| Колонка 1 | Колонка 2 | Колонка 3 |
|-----|-----|-----|
| Данные 1 | Данные 2 | Данные 3 |
| Данные 4 | Данные 5 | Данные 6 |

Выравнивание:
| По левому краю | По центру | По правому краю |
|:-------|:----:|-------:|
| Лево | Центр | Право |

Сноски

Это пример сноски[^1].

[^1]: Это содержание сноски.

Списки определений

Термин 1
: Определение 1

Термин 2
: Определение 2a
: Определение 2b

Аббревиатуры

HTML — это язык гипертекстовой разметки.

*[HTML]: HyperText Markup Language

GitHub Flavored Markdown (GFM)

Подсветка синтаксиса

Указание языка в блоке кода:

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

```json
{
  "name": "example",
  "version": "1.1.0"
}
```

Эмодзи

:smile: :heart: :thumbsup: :star:

Упоминания пользователей и ссылки на задачи

@имяпользователя
#123 (номер задачи)
организация/репозиторий#123

Поддержка HTML

Markdown поддерживает встроенные HTML теги:

<div style="color: red;">
  Это красный текст
</div>

<details>
  <summary>Нажмите для развёртывания</summary>
  Скрытое содержание
</details>

Экранирование символов

Используйте обратную косую черту для экранирования специальных символов:

\* не курсив
\# не заголовок
\[не ссылка\]

Символы, которые нужно экранировать:

\ ` * _ {} [] () # + - . ! |

Лучшие практики

1. Поддерживайте согласованность

Выберите один стиль заголовков и придерживайтесь его
Единообразно используйте * или - для маркированных списков
Поддерживайте одинаковые отступы (обычно 2 или 4 пробела)

2. Приоритет читаемости

Добавляйте пустые строки до и после заголовков
Разделяйте абзацы пустыми строками
Избегайте слишком длинных строк (рекомендуется 80-100 символов)

3. Семантическое использование

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

Частые ошибки

1. Ошибки в форматировании списков

Неправильно:
-Пункт один (отсутствует пробел)
- Пункт два

Правильно:
- Пункт один
- Пункт два

2. Ошибки в форматировании ссылок

Неправильно:
(текст ссылки)[URL]

Правильно:
[текст ссылки](URL)

3. Отступы в блоках кода

Неправильно:
```
код
```

Правильно:
```
код
```

Инструменты и советы

Использование MD-PDF-WORD

MD-PDF-WORD полностью поддерживает все эти синтаксисы Markdown и точно конвертирует их в форматы PDF и Word:

Сохраняет все форматирование
Правильно отображает таблицы
Поддерживает подсветку кода
Обрабатывает русскую типографику

Горячие клавиши (распространённые редакторы)

Функция	Windows/Linux	Mac
Полужирный	Ctrl + B	Cmd + B
Курсив	Ctrl + I	Cmd + I
Ссылка	Ctrl + K	Cmd + K
Код	Ctrl + `	Cmd + `

Образовательные ресурсы

Официальная спецификация: Официальная документация Markdown
Руководство GitHub: Руководство по GitHub Markdown
Интерактивные уроки: Учебник по Markdown
Предварительный онлайн-просмотр: используйте функцию предварительного просмотра в реальном времени в MD-PDF-WORD

Заключение

Овладение синтаксисом Markdown позволяет более эффективно создавать форматированные документы. От базового форматирования текста до продвинутых таблиц и блоков кода, Markdown предлагает богатые и при этом простые синтаксисы. В сочетании с такими инструментами, как MD-PDF-WORD, вы можете легко конвертировать документы Markdown в профессиональные форматы PDF или Word, удовлетворяя различные потребности в документообороте.

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

Практика Markdown прямо сейчас

Используйте онлайн-редактор MD-PDF-WORD для отработки этих синтаксисов

Открыть редактор Установить расширение