no about note

エンジニアのメモ書き

ownCloud+MDWikiでつくるプライベートなWikiがいい感じだった

Wiki

前回に引き続き、MarkdownWikiの話

noaboutsnote.hatenablog.com

なにがいい感じなのか

  • MDwikiは.mdファイルをMarkdownで表示してくれる軽量なWikiエンジン
  • mdwiki.htmlと同じ階層にある.mdファイルをMarkdownで表示してくれる
  • MDWikiはサーバサイドで編集しなければならないので、ownCloudを組み合わせることでブラウザから編集ができるようにする
  • 写真のアップロードが簡単にできて、ownCloudの編集画面が.mdファイルだと、シンタックスハイライトになって見やすい

使ってみた感想

  • ブラウザでWikiの内容を編集できるのは便利
  • ブラウザの編集画面がおかしな挙動をしたり、日本語表示がおかしなことがある
  • 拡張子が、txt、md、html以外だと編集ができない(.jsonなどはできない)

注意点

  • サーバ側でファイルを削除したりリネームするとブラウザ側で削除できなくなるので注意。

ownCloudのインストール

noaboutsnote.hatenablog.com

MDWikiをダウンロード

ここから最新版をダウンロードして、ownCloud上に保存する

ownCloud+MDWikiの設定

  • ownCloud上で、mdwiki.htmlをindex.htmlにリネーム
  • index.mdを作成して、Markdownで何か書いておく

シンボリックリンク作成

  • サーバ側の設定
  • ownCloudのドキュメントルートが /var/www/html だった場合の例
# cd /var/www/html/
# ln -s /var/www/html/owncloud/data/admin/files/mdwiki/ wiki

確認

http://localhost/wiki/

にアクセスして、index.mdがMarkdownで見れることを確認

MDWikiのカスタマイズ

ナビゲーションメニューの配置

  • mdwiki.htmlと同じディレクトリにnavigation.mdを配置し、以下を記述
  • ここからBootstrapを好みのものを選ぶ
  • 変更する場合は「flatly」の部分を書き換える
# navigation.md

[gimmick:Theme (inverse: true)](flatly)

[Home](index.md)
[Menu1](Menu1.md)

MDWiki - Theme chooser

config.jsonで設定編集

* useSideMenu  -> サイドメニューの有効/無効
* lineBreaks      -> 改行設定
* additionalFooterText   -> フッターテキスト
* anchorCharacter  -> アンカー記号
* title               -> ページタイトル (ブラウザのタブに表示される文言)

MDWiki - Configuration

# config.json

{
   "useSideMenu": true,
   "lineBreaks": "gfm",
   "additionalFooterText": "All content and images © by John Doe",
   "anchorCharacter": "#"
}

参考

パターン、Wiki、XP ~時を超えた創造の原則 (WEB+DB PRESS plusシリーズ)

パターン、Wiki、XP ~時を超えた創造の原則 (WEB+DB PRESS plusシリーズ)

入門Wiki―みんなで投稿/編集できるWebの作りかた

入門Wiki―みんなで投稿/編集できるWebの作りかた