コード日進月歩

しんくうの技術的な小話、メモ、つれづれ、など

GitHub上のmarkdownの確認はgistでやるといい感じにできる

厳密なGithub Flavored Markdownに対応しているテキストエディタって無いので、確認したいときの手法

手元でmdファイルを書くときの問題点

手元のEditorやIDEMarkdownで作成したファイルに関して作成するとかなり表示に差が出る、一番多いのは…

  • 改行の扱い(文中の改行を改行とみなすか否か)
  • 空行の必要/不必要(見出し後の空行)
  • スペースの有無(箇条書き、`の囲みなど)

あたりでかなり表示の差がでる。

GitHub向けの確認をするときに一番いいのはGist

エディタのプレビュー機能だと大きい部分は抑えてくれるものの、細かい部分は違ったりする。そのため、プレビューと該当サイトに載せたときの見た目が大きくことなる場合がある。

ブログサイトなどであれば直ぐに修正すればいいが、一番大変なのはGitHubGitHubはオンラインで編集する場合を除き、一回コミットしないとPreviewが表示されない。そのため手元で作った文章の見た目を確認するためには一回Commitしないといけないので、Commitを数回したくない場合には辛くなる。

そんなときにおすすめなのがGistでの確認。GistはいわずもがなGFMなので表示は変わらないし、Privateにして保存して、不要であれば削除してしまえばあとにも残らない

関連リンク