APIやSDK、ライブラリなどにドキュメントは必須です。しかも読みやすく、分かりやすいドキュメントでなければなりません。デザインに凝るのではなく、可読性を重視して作られるべきです。そういったドキュメントはなかなか作るのは難しいでしょう。

そこで使ってみたいのがdocsifyです。ドキュメントサイトを作るためのフレームワークになります。

docsifyの使い方

デモです。左側がメニュー、右側にコンテンツが表示されます。

多言語対応しており、右上のメニューから切り替えられます。

テーマもあります。こちらはbuble。

dark。

docsifyはデフォルトでは静的なHTMLを出力せず、動的に生成する形になっています。そのためUIとしてはスムーズなコンテンツ切り替えができるようになっています。また、SEO対策として静的なHTMLファイル出力も対応しています。

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

docsify

QingWei-Li/docsify: ? A magical documentation site generator.

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2