MDWiki をローカルや共有フォルダ上で運用する際に気を付けること

MDWiki をローカルに置いて一人 Wiki したり、仕事で共有フォルダに置いてチームメンバーやら上司やらと共有したりする用途を想定。

(はじめに)前提バージョン

IE では使えない

IE は未サポート。

Chrome で使う時は --allow-file-access-from-files 引数を

ローカルに置いた MDWikiChrome で開く場合、以下のコマンドラインが必要。

(Chromeのパス) --allow-file-access-from-files

参考: Offline support in Chrome · Issue #218 · Dynalon/mdwiki

コードハイライトは極力使わない

コードハイライト(バックチック三つで囲む + 言語名を指定する表記)を使うと、高確率で Firefox がフリーズ する。原因は不明。コード量が多いと出やすい傾向があるように思える。

ちなみに言語名指定無し(pre表記)ならフリーズしない。

Markdown の見出し構成は「1-大見出し」「N-中見出し」にする

MDwiki は Markdown の見出し構成を以下のように解釈する。

  • 大見出し → ページタイトル
  • 中見出し → TOC(目次)に表示する大見出し
  • 小見出し以降 → 何もしない

したがって Markdown ファイル中に 大見出しを複数書いていると TOC が正しく表示されない

見出し数は増やしすぎない(10以下が望ましい)

MDwiki の TOC は見出し数が多いと見切れてしまう。