単一 HTML ファイルで markdown ファイルを表示できる MDwiki を試してみた
MDwikiとは?
MDwiki - Markdown based wiki done 100% on the client via javascript
一言で言うと、ブラウザで mkwiki.html!#MARKDOWN_FILE.md
を開くだけで、MARKDOWN_FILE.md
の中身を HTML で表示してくれるやつ。TOC(目次)も付いてる。
サンプルは以下のとおり。
- こんなMarkdownファイル を、
http://dynalon.github.io/mdwiki/mdwiki-latest-debug.html#!index.md
← こんな URL で開くと、- こんなHTMLとして表示されます
なぜ使おうと思った?
Markdown ファイルをどうやって閲覧するかは悩ましい問題である。
テキストファイルだと「目次が無い」「ブラウザみたいにタブブラウズできない」「ブラウザみたいにリンクをクリックしてリンク先を開けない」といった弊害がある。
で、思ったのは Web ページみたいにブラウザで気軽に読めたら楽だよね ってことで、これを実現するにはどうしたらいいかと調べてみて、MDwiki がたぶん一番シンプルっぽいと結論。
※余談。他の手段としてはサイトジェネレータやビルドシステム等を使って md ファイルを html ファイルに変換する手があったが、このやり方は大掛かりだし難易度も高い。
入手
MDwiki ← このリンク先を保存する。
使用(単一ファイルの表示)
- 保存した html ファイルを、markdown ファイルが置いてあるフォルダに置く
- ブラウザで
mdwiki.html!#MARKDOWN_FILE.md
を開く
使用(Wikiみたいにファイル一覧を出したい)
- index.md に、各 Markdown ファイルへのリンクを書く
- ブラウザで
mdwiki.html
を開く
すると index.md に書いた通りにリンク一覧がずらっと表示されるはず。
所感
良い:
いまいち:
個人的結論
採用しない。
理由: TOC の作り方が残念すぎるから。
私は日本語テキストも Markdown で書いており、これをブラウザで見れることを期待した。が、TOC が中見出しのみで構成されるせいで、TOC 経由であちこち辿ることができない(ここ重要)。
私の日本語テキストは大見出し、中見出し、小見出しを用いたアウトライン構造で書かれ、見出し数は何十、時には 100 を超えることも多い。そのようなテキストも問題無く表示してほしかったのだが……MDwiki にはそのポテンシャルが無かったようだ。
リンク
- MDwiki:Markdownベースの超シンプルCMS / catch.jp memo
- カスタマイズ方法が詳しい
- mdwiki lang:ja - Twitter検索
- 色んな使用感とか呟かれていて参考になる
- 読み物としても面白い