1.markdown/マークダウンファイルをそのまま平文で表示するデモ

百聞は一見に如かず。ということでその様子を GIF で用意した。

Image from Gyazo

2.どんなときに役に立つのか?

markdown ファイルをそのまま表示したいときってどんなときか? たとえば、こんなときに使えるのではないだろうか。

  • ソースコードのある箇所を行単位でハイライトをつけるように markdown ファイルでも強調したい。
  • 書きっぷりを markdown 形式で確認したい
    • e.g.いいかんじの Mermaid 記法を見つけたけどこれどうやって書いてんだ!?

3.どうやるのか?

Github 上で markdown ファイルを開いてから URL の末尾に以下を追加するだけ!

?plain=1

すると、冒頭の GIF 動画のように markdown のまま表示される。

やってみよう!

Image from Gyazo

Image from Gyazo

Image from Gyazo

4.おまけ

記事を公開してまもなく、今回ご紹介したマークダウンファイルをマークダウン形式のまま表示する方法ですが、raw とも違うのねとコメントいただきました。

たしかにちがうぞ!!(言われて気がついた。raw の場合、プレーンテキストとして出力しているかんじ。)

Image from Gyazo

2022/03/07 更新

Github の GUI からでもできるよ!と教えていただいた。丸で囲んだボタンを押すと、この記事で紹介している ?plain=1 と同じようにマークダウンをマークダウンのまま表示できる。

Image from Gyazo

5.参考