Markdown の改行：行の区切り、段落、表のセル

Markdown の段落内で改行するには、最初の行の末尾にバックスラッシュを付けてから Enter を押します。別の段落を始めるには、空行を入れます。この 2 つは異なる文書構造を作るため、後で README、住所、レポートを Word に書き出す際に重要になります。

ドキュメントチーム\
サンプル通り 42 番地\
オレゴン州ポートランド

住所は 1 つの段落のまま、3 行に分けて表示されます。Markdown プレビューに貼り付けて、以下の例と比べてみてください。

必要な区切り方を選ぶ

改行しても改ページにはなりません。書き出す文書で次の節を新しいページから始めたい場合は、別記事の Markdown 改ページガイドをご覧ください。

Enter がスペースのように見える理由

次のソースを試してみてください。

下書きの準備ができました。
レビュー担当者は今日から開けます。

このサイトのプレビューでは、2 つの文は同じ段落に属し、続けて表示されます。ソースファイルの改行は読みやすさに役立ちますが、ブラウザーに表示上の改行を強制するものではありません。ブラウザーは利用可能な幅に応じてテキストを自動的に折り返します。

次に、空行を入れてみます。

下書きの準備ができました。

レビュー担当者は今日から開けます。

プレビューでは 2 つの段落になります。2 文目から新しい話題を始める場合はこちらを使います。空行を何行も追加して縦方向の余白を増やそうとしても、確実には機能しません。段落のスタイルはレンダラーや文書テンプレートが決めます。

バックスラッシュか行末の 2 個のスペース

CommonMark では、改行の直前に置いた 2 個のスペースと、改行の直前に置いたバックスラッシュを、段落内の強制改行の構文として定義しています。CommonMark の強制改行の例には両方の形式が記載されています。

バックスラッシュを使うと、ファイルをレビューするときに改行の指定を目で確認できます。

ドキュメントチームが作成\
リリース責任者がレビュー

もう 1 つの方法は、作成 の後にスペースをちょうど 2 個入力し、Enter を押すことです。このスペースは多くのエディターでは見えず、行末の空白を自動削除する機能で消される場合もあります。保存後に改行が消える場合は、空白の設定を確認するか、バックスラッシュを使ってください。

通常の文章に \n という 2 文字を入力しても改行にはなりません。これはプログラミング言語の文字列における慣例であり、Markdown の改行ではありません。また、段落の一番最後にバックスラッシュを置くのも避けてください。強制改行には、その後に同じ段落の次の行が必要です。

GitHub のコメントと README ファイルでは動作が異なる

GitHub の改行に関するドキュメントは、リポジトリの .md ファイルと、Issue、プルリクエスト、ディスカッションを区別しています。こうした会話の画面では通常の改行がそのまま表示上の改行になることがありますが、README には明示的な強制改行の構文が必要です。

そのため、Issue からコピーした文章が README では違って見えることがあります。同じウェブサイトのすべての画面が同じ書式ルールを使っていると考えずに、貼り付け先のファイルを確認してください。

続きの行をリスト項目の中に収める

続きの行を、項目の本文が始まる位置にそろえてインデントします。

- リリースノート\
  移行手順を含めます。
- インストールガイド

この例では最初の項目が 2 行で表示され、2 番目の項目は別のままです。最初の項目の中で別の段落を作るには、空行を入れ、続きの文章のインデントを保ちます。

- リリースノート

  移行手順と既知の問題を含めます。
- インストールガイド

インデントガイドでは、番号付きリスト、入れ子の箇条書き、項目内のコードを扱っています。

Markdown の表のセル内で改行する

GFM の表の 1 行は、ソースでも 1 行に書きます。内容の途中で Enter を押すと、表の行が分割されることがあります。HTML の改行を許可するレンダラーでは、次のように書けます。

| 文書 | 担当者 |
| --- | --- |
| リリースノート | 執筆者<br>レビュー担当者 |

このサイトのプレビューはこの例に対応しています。HTML を除去する出力先では、改行が削除されたり、タグがそのまま表示されたりする可能性があります。文書全体で採用する前に、対象プラットフォームで確認してください。セルに複数の段落が必要な場合は、表の外にリストを置くほうが管理しやすいことがよくあります。

表形式のデータには Markdown 表ジェネレーターを使い、配置やパイプ文字のエスケープについては表の構文ガイドをご覧ください。

書き出した文書を確認する

Markdown から Word への変換ツールを使う前に、通常の改行、明示的な強制改行、空行を 1 つずつ含む短いサンプルを試してください。プレビューには、それぞれ続けて表示される 1 つの段落、強制された改行、2 つの独立した段落が表示されるはずです。

ダウンロードした DOCX を開き、住所、リスト、表を確認します。元の改行構造が正しくても、ページの幅や Word の段落スタイルによって折り返し位置が変わることがあります。まず Markdown の構造を直し、特定の文書テンプレートで必要な場合は、最終的な文字組みを Word で調整してください。