Markdown — это простой способ форматирования текста с помощью обычных символов. Он используется повсюду — GitHub, Reddit, Notion, Discord, техническая документация и множество других платформ. Вместо нажатия кнопок для выделения текста жирным или создания заголовков вы вводите простые символы. Это руководство научит вас основам и позволит практиковаться с помощью нашего бесплатного инструмента Предпросмотр Markdown.
Что вам понадобится
- Веб-браузер (Chrome, Firefox, Safari или Edge)
- Без регистрации и установки
- Около 10 минут на изучение основ
Пошаговое руководство
Откройте инструмент Предпросмотр Markdown
Перейдите к инструменту Предпросмотр Markdown. Вы увидите редактор с разделённым экраном: слева — область для написания Markdown, справа — отформатированный предпросмотр в реальном времени. Каждое изменение мгновенно отображается в превью.
Изучите базовый синтаксис
Начните вводить текст в редакторе, чтобы поэкспериментировать с форматированием Markdown. Основной синтаксис прост и осваивается за минуты. Практикуйтесь с примерами ниже — вводите их слева и наблюдайте за отформатированным результатом справа.
Напишите свой документ
Теперь напишите фактическое содержимое. Используйте заголовки для структурирования документа, списки для организации информации, а жирный или курсивный текст для выделения. Предпросмотр в реальном времени гарантирует, что вы всегда видите, как выглядит итоговый результат по мере ввода.
Экспортируйте или скопируйте результат
Когда документ выглядит так, как вы хотите, скопируйте Markdown-текст для использования на любой платформе, поддерживающей этот формат, или экспортируйте отформатированный результат. Ваш Markdown-контент можно вставить в GitHub, Reddit, Notion или любой совместимый с Markdown редактор.
Полезно знать Markdown был разработан так, чтобы быть читаемым даже без рендеринга. Markdown-документ выглядит аккуратно и структурированно как простой текст — это одна из причин его популярности.
Основной синтаксис Markdown
Заголовки
Используйте символы # для создания заголовков. Больше символов # означает меньший заголовок:
# Заголовок 1 (самый крупный)
## Заголовок 2
### Заголовок 3
#### Заголовок 4
Жирный и курсивный текст
Оберните текст звёздочками для выделения:
**Это жирный текст**
*Это курсивный текст*
***Это жирный и курсивный текст***
Списки
Создавайте маркированные списки с помощью дефисов и нумерованные списки с помощью цифр:
- Первый пункт
- Второй пункт
- Третий пункт
1. Шаг первый
2. Шаг второй
3. Шаг третий
Ссылки
Создавайте кликабельные ссылки с помощью квадратных скобок и круглых скобок:
[Текст ссылки](https://example.com)
Код
Используйте обратные кавычки для встроенного кода и тройные обратные кавычки для блоков кода:
Встроенный: `console.log("hello")`
Блок кода:
```javascript
function greet(name) {
return "Hello, " + name;
}
```
Совет Не нужно запоминать всё сразу. Начните с заголовков, жирного текста и списков — эти три элемента покрывают 80% типичного написания в Markdown. Добавляйте больше синтаксиса по мере необходимости.
Изображения
Добавляйте изображения с помощью восклицательного знака перед синтаксисом ссылки:
Цитаты
Используйте > для создания цитат:
> Это цитата.
> Она может занимать несколько строк.
Где используется Markdown
| Платформа | Как используется Markdown |
|---|---|
| GitHub | README-файлы, issues, pull requests, комментарии |
| Форматирование постов и комментариев | |
| Notion | Содержимое страниц и документация |
| Discord | Форматирование сообщений |
| Stack Overflow | Вопросы, ответы и комментарии |
| Генераторы статических сайтов | Статьи блога и содержимое страниц |
Важно Разные платформы поддерживают немного разные возможности Markdown. Основы (заголовки, жирный, курсив, списки, ссылки) работают везде. Продвинутые возможности, такие как таблицы или сноски, различаются в зависимости от платформы. Всегда проверяйте предпросмотр перед публикацией на новой платформе.
Часто задаваемые вопросы
В чём разница между Markdown и HTML? Markdown конвертируется в HTML «за кулисами». Это более простой способ писать форматированный текст без запоминания HTML-тегов. Везде, где принимается Markdown, он отображается как HTML.
Можно ли использовать Markdown для профессиональных документов? Безусловно. Многие команды используют Markdown для документации, предложений и отчётов. Существуют инструменты для конвертации Markdown в PDF, Word и форматы презентаций.
Синтаксис одинаковый везде? Основной синтаксис универсален. Некоторые платформы добавляют расширения (например, GitHub Flavored Markdown, который добавляет таблицы и списки задач). Основы, рассмотренные в этом руководстве, работают везде.
Следующие шаги
Теперь, когда вы знаете Markdown, попробуйте написать README для проекта, отформатировать статью в блоге или создать техническую документацию. Для более сложных задач форматирования изучите наш Форматирование JSON для документации кода или Редактор PDF для итогового оформления документов.