社内での技術Tipsを残すためにMDwikiを使う

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

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

どんな人向け?

IT企業等でエンジニアをしていると、社内で技術メモを残したいことがあるかと思いますが
企業によっては、個人利用のためにツールを入れたり、Webサービスを使うことが難しいところもあると思います。
そんな過酷な状況で働くエンジニア向けです。

自分の場合のメモしておきたい内容の例としては

  • コードの書き方のちょっとしたメモ。(後から見返したときにパッとすぐ見たい)
  • トラブルシューティングの作業ログ。(画像や参考サイトなども付けて)
  • 担当プロジェクトに関するメモ(背景や自分の取り組みたいことなど、プロジェクトのドキュメントとして管理されてないけど残しておきたい情報)

などです。

Webサービス(Qiita TeamやQrunchなど)を使えばすぐ終る話ですが、なかなかそうも行かないと思いますので。

通った道

  • テキストファイルにメモに残す
  • ExcelやWordにメモを残す
  • 社内にすでにあるシステム内にメモを残す
  • こっそりWordPressやCrowiなどツールを入れて管理する

大抵上3つでメモを残すことになるかと思いますが自分の場合はコードのメモを残すことが多いため、どうしてもシンタックスハイライトが使えないとメモする気も起きません。

そしてさくっとテキストでメモできて見返すときも綺麗に見れるようにしたいためMarkdownが使いたい。

”MDwiki”

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経由でダウンロードするためオフライン環境では使用できないようです。

最後に

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

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

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

0件のコメント

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

技術ブログをはじめよう

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

技術ブログを開設する

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

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

Markdownで書ける

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

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

技術ブログ開設

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

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