ITエンジニア/デザイナ向けにオープンソースを毎日紹介

見やすいドキュメントは大事です。個人的にはmkdocsが好みですが、それ以外にもたくさんのドキュメント作成ソフトウェアがあります。ブログなどと組み合わせるならJykellを使っても良いですし、作られているプログラミング言語で選べば拡張もしやすいでしょう。

今回はnodeで作られているdocsifyを紹介します。シンプルで使いやすいドキュメントジェネレータです。

docsifyの使い方

ドキュメントはWebブラウザ上で見られます。

日本語も問題ありません。編集はリアルタイムに反映されます。

リンクも使えます。

docsifyは独自の機能も少なく、Markdownでさくさく書けると言った印象です。左側にアウトラインが表示され、右側にコンテンツが出ます。リンクはMarkdownファイルに対して行えて、表示上はHTMLになってくれます。あまり複雑な記法やお作法を気にしなくても使える手軽なソフトウェアです。

docsifyはnode/JavaScript製のオープンソース・ソフトウェア(MIT License)です。

docsifyjs/docsify: ? A magical documentation site generator.

docsifyjs/docsify-cli: ? docsify cli tool - A magical documentation generator.

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2