Markdownで改行が反映されない理由と、確実に改行する方法

Markdownのコラム

執筆:松村 誠(植木鉢団 代表)

箇条書きの下に一行足したら、前の行とつながって表示された。

原因はエディタの不具合ではなく、Markdownの仕様です。
改行の扱いには段階があって、書き方によって結果が変わります。

なぜ1行の改行は消えるのか

標準のMarkdownでは、単独の改行は「行の区切り」ではなく「単語の区切り」として扱われます。
HTMLに変換したときに、改行のまま残すか半角スペースにするかは処理系によって違いますが、どちらもブラウザでは空白1つ分として表示され、行は変わりません。

たとえば次のように書いたとします。

朝ごはんを食べた
昼ごはんも食べた

これは1つの段落として扱われ、表示はこうなります。

朝ごはんを食べた 昼ごはんも食べた

ソースの見た目を整えるための改行と、文章として意味のある改行を区別するための仕様です。
1行が長くなったところで適当に折り返してソースを読みやすくしても、表示は崩れない。そういう作りになっています。

意図どおりに改行する書き方

  1. 空行を入れる:前後が別々の段落に分かれます。どの処理系でも通じる方法です。※段落として分かれるため、行間に余白が入ります。
  2. 行末に半角スペースを2つ置く:同じ段落の中で改行されます。
    ただし、この2つのスペースは画面上では見えません。
    エディタの「保存時に行末の空白を削除する」設定やコピー&ペーストの経路で消えて、後から開くと改行が消えている、ということが起きます。
  3. 行末にバックスラッシュを置く:CommonMarkに準拠した処理系であれば、行末の \ でもスペース2つと同じ結果になります。
    スペースと違って目に見えるので、消えたかどうかが分かります。

そのほか、<br> タグを直接書く方法もあります。※HTMLを許可していない処理系では取り除かれます。

4か所で表示を比べた

単独の改行の扱いは、処理系によって変わります。同じサービスの中でも、場所によって変わることがあります。
同じ文を、次の4か所で表示して比べました。

  • LiteMD のプレビュー
  • GitHub のコメント欄と同じ扱い(GitHub の Markdown 変換で gfm を指定)
  • GitHub のREADMEと同じ扱い(同じく markdown を指定)
  • CommonMark 標準どおりの処理系(micromark 4.0.2)
書き方LiteMDGitHubのコメントGitHubのREADMECommonMark
1行の改行改行改行つながるつながる
行末スペース2つ改行改行改行改行
行末の \改行改行改行改行
<br>改行改行改行改行

違いが出たのは、1行の改行だけでした。
GitHub では、コメント欄では1行の改行がそのまま反映され、リポジトリに置いたREADMEでは標準どおりにつながります。コメント欄で書き慣れた書き方のままREADMEを書くと、改行が消えて見えるのはこのためです。
LiteMD は、試した書き方のすべてで GitHub のコメント欄と同じ表示になりました。LiteMD のプレビューで整えた文章をREADMEのような場所に貼ったら1行につながった、という場合はこれが原因です。

LiteMDの編集画面とプレビュー。1行の改行・行末スペース2つ・行末のバックスラッシュの3通りで書いた文が、プレビューではどれも改行されている
LiteMDで3通りの書き方を並べたところ。プレビューではどれも改行され、行末のスペース2つは編集画面では見えません。

箇条書きの中で段落を分けたいとき

箇条書きの1項目の中で、段落を分けたいこともあります。
このときは、空行のあとに続ける行を、項目の文字の位置まで字下げします。
字下げした場合は、4か所とも項目の中の段落として表示されました。

字下げをせずに書くと、崩れ方は書き方で分かれます。4か所とも同じ結果でした。

  • 空行のあとに字下げせず書く:箇条書きはそこで終わり、その行は箇条書きの外の段落になります。後ろに次の項目を書いても、別の箇条書きとして始まり直します。
  • 番号付きの箇条書きで、字下げしない段落のあとに空行を入れて「2.」を書く:2から始まる別の番号付きの箇条書きになります。
  • 同じく、空行を入れずに「2.」を書く:「2. 二つ目」が、前の段落の続きの文字として表示されます。

見た目では番号が続いているように見えても、中では別の箇条書きになっていることがあります。
項目の中に説明を足すときは、字下げがそろっているかを先に確かめると崩れません。

持ち出す予定があるなら明示的に書く

自分の中だけで完結する文書なら、使っているツールの挙動に合わせて構いません。
別の場所に貼る予定があるなら、1行の改行に頼らず、空行かバックスラッシュで改行を指定しておくと、上の表のどこに貼っても同じ表示になります。

行末スペース2つも表の上では全部で通じますが、書いた本人にも見えないのが難点です。
消えても気づけないため、後から読み返す文書には向かないところがあります。