VSCodeでもGitHubのMarkdownのように改行する


GitHubの改行は独自仕様

マークダウンの正式な仕様的には、


  • 半角スペース*2を行末に入れると改行

  • ただの改行では改行したことにならない

というようになっており、もちろんVScodeもその仕様通りに動きます。

しかし、GitHubではただの改行も改行されちゃうので、Git管理されているmdファイルを

VSCodeでイジるとpreviewがどえらいことになったり、逆にVSCodeのpreviewでイイカンジに

したつもりがpushしてGitHub上で確認したときにどえらいことになっていたりします。


すみません、Pull Requestを作ったときの本文やコメント欄だけでした。

mdファイルはちゃんと仕様どおりに後ろに半角スペースが必要ですね。


対策

VSCodeの設定で以下行を追加します。

markdown.preview.breaks: true

GitHubのPR・コメント用途以外のMarkdownとか編集しねぇよ、って人はエディタ設定に、

それ以外も編集する人はプロジェクト単位の設定にすると良いと思いますよ。

そういえばQiitaの投稿エディタもただの改行で改行されるので、

Qiita記事をVSCodeで下書きしたい人も上記設定刺さると思います。