【MDwiki】HtmlとMarkdownファイルを置くだけで作成できる!自分専用Wikiツールのご紹介

まやだです!気づけばとっくに新年度が過ぎていました。も、もうゴールデンなウィークのシーズンが差し迫っているだと……。

というわけで、本日はツールご紹介系の記事を書かせて頂きます。

MDwiki - http://dynalon.github.io/mdwiki/#!index.md

軽量で、設置が楽で、Markdown記法でぱぱっと書ける、そんな便利なドキュメントツールとしてぴったりなのがこちらのMDwikiでございます。
ものすごく便利なのですが未だ日本語圏での情報をあまり見かけないのでご紹介します。

ダウンロードから設置まで



  1. まずこちらのページからmdwiki-latest.htmlを右クリックで保存するか、またはそのリンク先のページからzipファイルをダウンロードして解凍します。

  2. 保存または展開したmdwiki~.htmlとなっているファイルのいずれか(どれでもいい)を任意の名前(index.htmlなど)にリネームし、ブラウザでアクセス可能な任意のサーバーに置きます。特にカスタマイズするなどでなければzipファイル内のmdwiki-slim.htmlが最軽量なのでそちらがいいと思います。

  3. index.mdファイルを作成します。運用したいWikiの内容に合わせて適宜編集します。
    <!-- index.md -->

    じぶんじぶんWiki
    =======

    見出しを書くところ
    ----------

    このWikiはわしが育てた

    * Markdownで
    * いろいろ書けるよ

    これはリンクですよ [リンク先](http://google.co.jp).

  4. 作成したindex.mdを上記のhtmlファイルと同じディレクトリに置きます。
    public_html/ ※一例
    ├ index.html
    └ index.md

  5. さっそくブラウザからアクセスしてみます。

20160422_01_myd.png

なんとここまで簡単に設置できてしまいました。カップラーメンを作るより簡単だ……!
たぶんですがお湯を沸かすぶんカップラーメンのほうが大変だろうなとなんとなく思っておりますがまったく根拠はありません。

ちなみにページを増やしたい場合はどんどんmdファイルを置いてナビゲーションなどから適宜リンクさせるだけでいいです。
サブディレクトリにも対応してますので、その場合は下記のような感じでアクセスできます。
public_html/
├ subdir/
|└ sub.md
├ index.html
└ index.md
http://your-site-url/#!subdir/sub.md でアクセス可

ナビゲーションの設置


ルート・ディレクトリ直下に下記のようにnavigation.mdファイルを置くことでナビゲーションが使えます。
<!-- navigation.md -->

# じぶんじぶんWiki

[Home](home.md)
[About](about.md)
[Download](download.md)
public_html/
├ index.html
├ index.md
└ navigation.md

20160422_02_myd.png

だいぶドキュメントっぽくなりました。

デザインの変更


Gimmicksというプラグイン的なものが用意されてまして、その中のTheme chooserという機能を使うことで簡単にデザインを変更できます。
下記の通りgimmick:〜の記述をnavigation.mdに追加します。
<!-- navigation.md -->

# じぶんじぶんWiki

[Home](home.md)
[About](about.md)
[Download](download.md)

[gimmick:themechooser](Choose theme)
[gimmick:theme (inverse: true)](flatly) <!-- デフォルトで表示させたいテーマ -->

20160422_03_myd.png

デフォルトのデザインを変更かつ閲覧者がデザインを選べるようになりました。べんり!

他にもいろいろとできることはあるのですが、その点はやはり公式サイトのドキュメントが詳しいのでそちらをご参照頂ければと思います!
(英語表記ではありますが具体的な設置例などあって大変わかりやすいです)

デメリットとしては静的ファイルのみを置くという都合上、複数人での共同編集には向いていないです(いろいろ共有設定などしてどうにかして使うという手もありますが)
ただ敢えて自分専用にクローズドなWikiを作りたいなどの場面ではこちらが大変重宝するのではないかと思います。

最後になりましたが弊社、WikiレンタルサービスもございますのでWikiつながりでこちらもそっとご紹介させて頂きます。笑

ではでは!


この記事へのコメント