Visual Studio Code 更新したら md ファイルが黄色くなっちゃった
VSCode のバージョンが相当古かったので最新化した。
今まで綺麗だった md ファイルに黄色がいっぱい…
Markdown にも記法ルールがある
原因はわからないですが、コーディング規約をチェックしてくれるプラグインmarkdownLintが働いてくれた様子。
規約守らなくてもmdファイルとしては大丈夫なそうですが、先人たちがまとめてくれた規約は知っておいた方がいいし、従わない理由がないなら従った方がいい。
MD022 blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
タイトル行はブランク行で囲みましょうね、とのことです。
他にはどんなルールが？
markdownLint さんには50個のルールが書かれた。
プラグインの「詳細はここ見てね」に、がっつり書かれてる。
DavidAnson/markdownlint
2019年08月の記事なので47とありますが、よく引っかかってしまうルールを日本語で分かりやすく解説してくださっている記事も参考になりました。
Markdown 47のルール
memo
markdown のコーディング規約を調べていたら、普段使っている python や JavaScript のコーディング規約も興味がでてきました。
PEP8 というものがあるらしい…調べてみる。