Column

その他あれこれ
複数人で執筆するMarkdownドキュメントの体裁の整え方
2024.10.24

こんにちは。Cardio Flow Designの今井です。

 

複数人でMarkdownで文書を執筆することがあると思います。

その際、書く人により体裁がさまざまであるため表記に統一性がなく、読みづらくなってしまうことがあります。

そのような場合に役立つ「markdownlint」と「テキスト校正くん」というVS Codeの拡張機能を紹介します。

 

・markdownlint(https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)

・テキスト校正くん(https://marketplace.visualstudio.com/items?itemName=ICS.japanese-proofreading)

 

上記の拡張機能をインストールし、markdownファイルを開くと、

markdownlintで指摘される事項は黄色の波線、テキスト校正くんで指摘される事項は赤い波線で表示されます。

 

波線部分にホバーすると指摘事項が確認できます。

 

 

指摘事項に従い文章を直すと、だれが書いても統一した体裁で書くことができ文書が読みやすくなります。