wiki を markdown で記述する mdWiki が使いやすかった

markdown で適当に書くだけで簡単な Wiki が作れるツール mdWiki が便利だったのでメモ。

ダウンロード・インストール

MDWikiのドキュメントから「How does it work?」の download page リンクにとび、Get the Latest Release からダウンロードページに行ける。そこで最新バージョンをダウンロードすればいい。単純に言うなら、mdwiki-0.6.2.zip をダウンロードする。

インストールは非常に簡単で、というよりも、mdwiki-0.6.2.zip を解凍したフォルダにある mdwiki.html を利用すれば実行できる。mdwiki.html の中身を変更する必要は一切ない。

mdwiki.html を開くと、メニューバーとまっさらなページが表示される。mdwiki.html はデフォルトのページとして index.md を開こうとするので、まず index.md を作成してみることにしよう。

基本的な記述の仕方は markdown 記法で問題ないけど、一部 MDWiki 特有の表記が必要だったりする。

そのファイルで最初の # はページタイトルと解釈され、ページ上部に表示される。それ以外の # は普通の見出しとして表示される。

見出し 2 である ## は見出しとして表示されるだけでなく、サイドメニューとして表示される。各項目をクリックすると、その項目のページ位置までジャンプすることができる。

後の記述は普通の markdown と同じ（はず）。MDWikiのドキュメントではリンクや画像、シンタックスハイライトの記法が紹介されていますが、恐らく違いはない（はず）。

wiki というからには、index.md だけでなく色々なページを表示させたい。リンクからとぶのもありだが、どうせなら上部のメニューバーからとべるようにしたい。

これを行うには、mdwiki.html と同じフォルダに navigation.md というファイルを配置する。メニューバーに新しく要素を追加したい場合は、このファイルを編集すればよい。

このファイルも markdown で記述するけど、フォーマットが若干特殊。

見出し 1 # はメニューバーの左端にタイトルとして表示される。これが複数あってもただ単に文字列が繋がるだけなので意味はそんなにない。

メニューバーに要素を追加したい場合は、[Menu Item]() のように書く。末尾の () に何も記述しない場合は、クリックしても何も起こらないパネルになるか、あるいはドロップダウンリストにリンクを追加すればそのページへのリンクとなる。

要素にドロップダウンリストを追加したい場合は、次のような記述が可能。

[Menu Item]()

  * # Sub Menu Title
  * [Sub Menu Name](Link)
  - - - -
  * …

サブメニューの行頭の*は必須だと思う。要素の記述とリストの記述の間には空行を入れる必要がありそう。- - - - は区切り線。

なお、メニューバーのスタイルを変更したい場合、Gimmicks という機能を利用することができる。単に [gimmick:themechooser](Choose Style) と書けばドロップダウンリストが表示され、スタイルが変更できるようになる。

多分、使い方はこれだけで十分のはず。あとは使いたければチュートリアルを見れば画像とかの追加はできる。個人や小規模なチームでの情報をまとめる程度ならこれで十分だと思う。が、実運用してないからなんとも言えない……。

まぁ、しばらく個人用で色々まとめてみたいと思ってる。