1.markdown/マークダウンファイルをそのまま平文で表示するデモ
百聞は一見に如かず。ということでその様子をGIFで用意した。
2.どんなときに役に立つのか?
markdownファイルをそのまま表示したいときってどんなときか? たとえば、こんなときに使えるのではないだろうか。
- ソースコードのある箇所を行単位でハイライトをつけるようにmarkdownファイルでも強調したい。
- 書きっぷりをmarkdown形式で確認したい
- e.g.いいかんじのMermaid記法を見つけたけどこれどうやって書いてんだ!?
3.どうやるのか?
Github上でmarkdownファイルを開いてからURLの末尾に以下を追加するだけ!
?plain=1
すると、冒頭のGIF動画のようにmarkdownのまま表示される。
やってみよう!
- 対象のmarkdownファイルのURL
- markdownファイルのURLの末尾に
"?plain=1"
をつけると、、できた!!
- 一般的なファイルのように行単位でハイライトをつけることもできるぞ!
4.おまけ
記事を公開してまもなく、今回ご紹介したマークダウンファイルをマークダウン形式のまま表示する方法ですが、rawとも違うのねとコメントいただきました。
なるほど、raw ともまた違うのですね https://t.co/EZaXLIjiLm
— よこち (@akira6592) March 3, 2022
たしかにちがうぞ!!(言われて気がついた。rawの場合、プレーンテキストとして出力しているかんじ。)
2022/03/07更新
GithubのGUIからでもできるよ!と教えていただいた。丸で囲んだボタンを押すと、この記事で紹介している ?plain=1
と同じようにマークダウンをマークダウンのまま表示できる。