Базовый синтаксис Markdown
Markdown - это легковесный язык разметки с простым синтаксисом, который позволяет вам сосредоточиться больше на содержании, чем на форматировании. Он использует читаемый и записываемый текстовый формат, может смешиваться с HTML и может быть экспортирован в HTML, PDF или собственный файловый формат .md.
Философия дизайна
Цель Markdown - "читаемость и простота написания".
Читаемость - самое важное. Файл, написанный в Markdown, должен быть опубликован как обычный текст и не выглядеть заполненным тегами или инструкциями по форматированию.
Основная цель дизайна синтаксиса Markdown - сделать его максимально читаемым. Исходя из этой цели, документы Markdown могут быть опубликованы как обычный текст без видимости, что они заполнены тегами или инструкциями по форматированию.
—— Джон Грубер
Совместимость с HTML
Цель синтаксиса Markdown - быть языком написания, подходящим для веба.
Markdown не стремится заменить HTML и даже не стремится быть к нему близким. Его синтаксис ограничен и охватывает только небольшое подмножество HTML-тегов.
Теги, не охваченные Markdown, могут быть написаны непосредственно в документе с использованием HTML. Нет необходимости отмечать, является ли это HTML или Markdown; просто добавьте теги напрямую.
Например, добавление HTML-таблицы в файл Markdown:
Это обычный абзац.
<table>
<tr>
<td>Foo</td>
</tr>
</table>
Это еще один обычный абзац.Автоматическое преобразование специальных символов
В HTML-файлах два символа требуют специальной обработки: < и &.
<используется для открывающих тегов&используется для HTML-сущностей
Markdown позволяет вам естественно писать эти символы и обрабатывает преобразование за вас. Если &, который вы используете, является частью HTML-сущности, он будет сохранен; в противном случае он будет преобразован в &.
Базовые элементы синтаксиса
Базовый синтаксис Markdown включает следующие элементы:
Блочные элементы
- Заголовки - Использование
#для создания заголовков различных уровней - Абзацы и разрывы строк - Правила текстовых абзацев и разрывов строк
- Цитаты - Использование
>для создания цитат - Списки - Упорядоченные и неупорядоченные списки
- Блоки кода - Специальный формат для отображения кода
- Горизонтальные линии - Создание горизонтальных линий
Строчные элементы
- Выделение - Жирный и курсивный текст
- Ссылки - Создание гиперссылок
- Изображения - Вставка изображений
- Встроенный код - Метки встроенного кода
Прочее
- Экранирование - Экранирование специальных символов
- Автоссылки - Автоматическое распознавание ссылок
Пример синтаксиса
Ниже приведен пример, содержащий различные базовые элементы синтаксиса:
# Мой документ
Это пример **жирного текста** и *курсивного текста*.
## Пример списка
### Список покупок
- Яблоко
- Банан
- Апельсин
### Список задач
1. Изучить основы Markdown
2. Практиковаться в написании
3. Поделиться с друзьями
> Это пример цитаты. Markdown делает написание простым и элегантным.
Это [пример ссылки на домашнюю страницу](/ru/).
Пример кода:Вы также можете использовать встроенный код, например, console.log('Hello World').
Лучшие практики
Заголовки
- Используйте только один заголовок первого уровня (
#) в документе - Сохраняйте логику уровней заголовков; не пропускайте уровни
- Оставляйте пустые строки перед и после заголовков
Форматирование списков
- Сохраняйте последовательность символов неупорядоченных списков (используйте только
-,*или+) - Нет необходимости в пустых строках между элементами списка, если нет нескольких абзацев
Ссылки и изображения
- Предоставляйте осмысленные текстовые описания для ссылок
- Предоставляйте альтернативный текст для изображений
Отображение кода
- Используйте встроенный код для коротких фрагментов
- Используйте блоки кода для длинного или многострочного кода
- Указывайте язык для блоков кода, чтобы включить подсветку синтаксиса
Поддержка инструментов
Почти все приложения Markdown поддерживают эти базовые элементы синтаксиса. Могут быть незначительные различия между разными процессорами Markdown, но базовый синтаксис универсален.
Следующие шаги
Теперь, когда у вас есть обзор базового синтаксиса Markdown, вы можете:
- Углубиться в каждый элемент синтаксиса
- Посмотреть шпаргалку для быстрой справки
- Изучить расширенный синтаксис для дополнительных возможностей
- Исследовать расширенное использование и лучшие практики
Начните изучение конкретных элементов синтаксиса: