Markdownの行末スペース2文字による強制改行

概要

Markdownでは、通常の改行（単に Enter キーを押すだけ）では改行されず、テキストが連結されてしまいます。強制的に改行を挿入するには、行末に2つ以上の半角スペースを入力し、その後に改行します。

対応している仕様

この仕様は、以下の主要なMarkdown方言でサポートされています。

• CommonMark
  • https://spec.commonmark.org/0.31.2/#hard-line-break
• GitHub Flavored Markdown (GFM)
  • https://github.github.com/gfm/#hard-line-break

具体例

例1：強制改行あり

入力：

これは第一行です  
これは第二行です

（※「です」の後ろに半角スペース2つ）

出力：

これは第一行です
これは第二行です

例2：強制改行なし

入力：

これは第一行です
これは第二行です

出力：

これは第一行ですこれは第二行です

この仕様を調べたきっかけ

Swaggerで利用するYAMLファイルを修正していたところ、description タグ内では行末に半角スペース2文字を入力すべきとするコーディング規約がありました。しかし、それを知らずに空白なしでコミットしたため、レビュー者から指摘を受けました。

調べてみると、Swaggerの description タグでは CommonMark がサポートされており、このコーディング規約はCommonMarkの仕様に基づくものでした。

description is extended information about your API. It can be multiline and supports the CommonMark dialect of Markdown for rich text representation.

参考：https://swagger.io/docs/specification/v3_0/basic-structure/

Swaggerの仕様はもちろん、半角スペース2文字による改行というCommonMarkの仕様も知らなかったため、本記事で簡単にまとめました。