Переносы строк в Markdown: новые строки, абзацы и ячейки таблиц
Добавляйте новую строку в Markdown обратной косой чертой, двумя пробелами или пустой строкой. Исправляйте переносы в README, списках и таблицах перед экспортом в Word.
Чтобы начать новую строку внутри абзаца Markdown, поставьте обратную косую черту в конце первой строки, затем нажмите Enter. Чтобы начать отдельный абзац, оставьте пустую строку. Эти способы создают разную структуру документа, что важно при последующем экспорте README, адреса или отчёта в Word.
Отдел документации\
Примерная улица, 42\
Портленд, Орегон
Адрес остаётся одним абзацем, отображаемым в три строки. Вставьте его в предпросмотр Markdown, чтобы сравнить с примерами ниже.
Выберите нужный тип разрыва
| Желаемый результат | Исходный Markdown | Типичное применение |
|---|---|---|
| Продолжить тот же абзац | Обычный перевод строки | Разбиение длинных строк исходника |
| Начать другую строку в том же абзаце | Обратная косая черта, затем Enter | Адреса и короткие стихотворения |
| Начать новый абзац | Пустая строка | Разделение мыслей в статье |
| Перенести текст внутри ячейки таблицы | <br>, если поддерживается HTML | Две короткие подписи в одной ячейке |
Перенос строки не создаёт разрыв страницы. Если следующий раздел экспортированного документа должен начинаться с нового листа, обратитесь к отдельному руководству по разрывам страниц в Markdown.
Почему Enter может выглядеть как пробел
Попробуйте такой исходный текст:
Черновик готов.
Рецензент может открыть его сегодня.
В предпросмотре этого сайта оба предложения относятся к одному абзацу и идут подряд. Перевод строки полезен в исходном файле, но не заставляет браузер начинать новую видимую строку. Браузер всё равно может переносить текст в зависимости от доступной ширины.
Теперь вставьте пустую строку:
Черновик готов.
Рецензент может открыть его сегодня.
Предпросмотр создаёт два абзаца. Используйте этот вариант, когда второе предложение начинает новую мысль. Несколько пустых строк не гарантируют дополнительный вертикальный отступ: оформление абзацев задаётся средством отображения или шаблоном документа.
Обратная косая черта или два пробела в конце
CommonMark определяет два пробела перед переводом строки и обратную косую черту перед переводом строки как синтаксис принудительного переноса внутри абзаца. Обе формы описаны в примерах принудительных переносов CommonMark.
Вариант с обратной косой чертой хорошо виден при проверке файла:
Подготовлено отделом документации\
Проверено ответственным за выпуск
Альтернативный вариант: введите ровно два пробела после документации, затем нажмите Enter. Во многих редакторах эти пробелы невидимы и могут удаляться автоматической очисткой пробелов в конце строк. Если перенос пропадает после сохранения, проверьте настройки пробельных символов или используйте обратную косую черту.
Не вводите два символа \n в обычном тексте в ожидании переноса. Это соглашение для строк в программировании, а не перевод строки Markdown. Также не ставьте обратную косую черту в самом конце абзаца: после принудительного переноса должна идти ещё одна строка содержимого этого абзаца.
Комментарии GitHub и файлы README ведут себя по-разному
В документации GitHub о переносах строк различаются файлы .md в репозиториях и задачи, запросы на слияние и обсуждения. В этих разделах общения обычные переводы строк могут отображаться как переносы, тогда как в README нужен явный синтаксис принудительного переноса.
Поэтому текст, скопированный из задачи, может иначе выглядеть в README. Проверяйте целевой файл, не предполагая, что все разделы одного сайта используют одинаковые правила форматирования.
Сохраните продолжение внутри пункта списка
Сделайте отступ продолжения до начала текста пункта:
- Примечания к выпуску\
Добавить инструкции по миграции.
- Руководство по установке
Здесь первый пункт отображается в две строки. Второй остаётся отдельным пунктом. Для отдельного абзаца внутри первого пункта добавьте пустую строку и сохраните отступ продолжения:
- Примечания к выпуску
Добавить инструкции по миграции и известные проблемы.
- Руководство по установке
В руководстве по отступам разобраны нумерованные списки, вложенные пункты и код внутри пункта.
Добавьте новую строку в ячейку таблицы Markdown
Строка таблицы GFM должна целиком находиться на одной строке исходника. Нажатие Enter внутри её содержимого может разбить строку таблицы. В средствах отображения, допускающих HTML-переносы, используйте такой шаблон:
| Документ | Ответственные |
| --- | --- |
| Примечания к выпуску | Автор<br>Рецензент |
Предпросмотр этого сайта поддерживает данный пример. Целевая платформа, удаляющая HTML, может убрать перенос или показать тег, поэтому проверьте её, прежде чем применять этот способ ко всему документу. Если в ячейке нужно несколько абзацев, список за пределами таблицы часто проще поддерживать.
Для табличных данных используйте генератор таблиц Markdown, а для выравнивания и экранирования вертикальных черт смотрите руководство по синтаксису таблиц.
Проверьте экспортированный документ
Перед использованием конвертера Markdown в Word проверьте короткий образец с одним обычным переводом строки, одним явным принудительным переносом и одной пустой строкой. Предпросмотр должен соответственно показывать один непрерывный абзац, принудительный перенос и два отдельных абзаца.
Откройте скачанный DOCX и проверьте адрес, списки и таблицу. Ширина страницы и стили абзацев Word могут менять перенос текста, даже если сами разрывы заданы правильно. Сначала исправьте структуру Markdown; окончательное оформление настройте в Word, если этого требует конкретный шаблон документа.