MarkDown記法って日本語で記事書くのに向いてない話

仕事柄や自分用メモでMarkdown記法に触れることが多々ある。
このサイトの文章も基本的にはMarkdown記法である。
VSCode(Visual Studio Code)で書いているが、他Markdownツールと比べて使用感については不便な部分もある。

本記事ではそんな愚痴と解決法を紹介する。

正式なMarkdown記法での改行

正式なMarkdown記法においては、改行は「半角スペース２つ」が必要である。
行末に半角スペースを２つ入れないと改行はされない。
Markdownのプレビューが表示されていれば改行されていないことに気づけるが、プレビュー無しで編集している場合、なかなか気付けないことが多い。

日本語で文章を入力している場合、全角入力をしているため半角を２つ入力するのが手間だったりする。

使ったことのある以下のMarkdownテキストツールではその辺の対策がある。

• Inkdrop
  • 公式プラグインにてEnter１つでの改行に対応
• Obsidian
  • 厳密な改行設定によってEnter１つでの改行に対応
• Qiita
  • デフォルトでEnter１つでの改行に対応

確認はしていないが、上記の対策は

• 生の.mdファイルをそれぞれのツールにおいて改行コードがあったら改行するという処理なのか
• 改行の際に半角スペース２つを挿入しているのか

のどちらかである。

VSCodeでMarkdown記法→GithubにPush→Netlifyという流れだと、やはり正式なマークダウンの形式に従って半角スペース２つを入れるしかなさそうである。

考えられる解決法

Ctrl + Shift + V でプレビューモード

VSCode標準機能としてMarkdownのプレビューモードが存在する。
見出し、箇条書き、改行が正しいかすぐチェックできるので、改行し忘れのミスはまず起こらない。
現在はVSCode右上にもプレビューモードをサイドバイサイドで表示するアイコンがあるため、場所がわからないということはないと思う。

スペースを視覚的に表示する

VSCodeではスペースを視覚的に表示することができる。

ファイル→ユーザー設定→設定→Editor:Render Whitespace

• none
• boundary 単語間の単一スペース以外
• selection 選択したテキストのみ空白を表示
• training 末尾の空白のみ表示
• all 全部表示

お好みで良いと思う。

おわりに

以上愚痴であった。
せっかくだからちゃんとしたMarkdown記法を操れるように末尾の半角スペース２つに慣れることにする。