技術Tipsを残すためにMDwikiを使う

公開日:2019-06-08
最終更新:2019-07-07

こんな感じのwikiがさくっと手に入ります。

MDwiki

MDwikiはMarkdownで記載したmdファイルをブラウザでさくっと見ることができます。
最低限必要なファイルは2つだけ(名前は変更可)

  • mdwiki.html (mdファイルをhtmlに変換するためのコアファイル)
  • index.md (このファイルに記載した内容がブラウザで見れるようになります)

カテゴリ別に分けたい場合など、mdファイルを自由に追加できます。
また、画面上部ナビゲーションバーにメニューを追加したい場合にはnavigation.mdファイルを追加します。
とにかく試したい場合には、2ファイルから始められるってのがとても素晴らしいですね。

導入

  1. 公式のDownloadよりダウンロード
  2. webサーバがローカルに立っているのであれば、htmlファイルとmdファイルを配備して「mdwiki.html」にアクセス
    ※使用ブラウザがFireFoxの場合には、一部機能は利用できないものの、webサーバ不要でローカルファイルを開けば使用可能
  3. mdファイルをお好みに編集(文字コードはUTF-8で作成)

できること

公式のドキュメントやこちらのサイトで使用できるMarkdownの記法などについて記載されています。

  • コードハイライト
  • 画像の挿入
  • MDwiki内でのページリンク
  • ナビゲーションバーに項目追加(サブメニューみたいな感じに追加できる)

などMarkdownで基本的に書けることには対応していますし、wiki内でのリンクも可能です。

そして、Gimmicksという独自の要素によってさらに表現が拡張されています。MDwiki>Gimmicks

簡単なUMLダイアグラムやフロー、GoogleMapsなどを埋め込むことが可能です。
※ただしUMLダイアグラムなどは、cssをweb経由でダウンロードするためオフライン環境では使用できないようです。

なぜMDwikiを調べたか

IT企業等でエンジニアをしていると、社内で技術メモを残したいことがあるかと思いますが
企業によっては、個人利用のためにツールを入れたり、Webサービスを使うことが難しいところもあると思うので・・・
特にインストールなどせずにhtmlファイルとmdファイルのみで動くMDwikiがイイ感じでした。
(個人用ならBoostnoteなど使えるといいのですが・・・)
個人用でなくとも、プロジェクト用のwikiとして使用したりするのも良いかもしれません。

要調査

  • wiki内で全文検索はできないので現状grep検索
  • ナビゲーションバー内のコンテンツが増えすぎた場合、どのように整理するか?

最後に

技術Tipsメモ以外にも色々と使い方があると思います。
是非、MDwiki使用してみてください。

記事が少しでもいいなと思ったらクラップを送ってみよう!
3
+1
@yayaの技術ブログ

よく一緒に読まれている記事

0件のコメント

ブログ開設 or ログイン してコメントを送ってみよう
目次をみる

技術ブログをはじめよう

Qrunch(クランチ)は、ITエンジニアリングに携わる全ての人のための技術ブログプラットフォームです。

技術ブログを開設する

Qrunchでアウトプットをはじめよう

Qrunch(クランチ)は、ITエンジニアリングに携わる全ての人のための技術ブログプラットフォームです。

Markdownで書ける

ログ機能でアウトプットを加速

デザインのカスタマイズが可能

技術ブログ開設

ここから先はアカウント(ブログ)開設が必要です

英数字4文字以上
.qrunch.io
英数字6文字以上
ログインする