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

開発者向けのドキュメントはDX(Developer Experience。開発者体験)を語る上で欠かせない存在です。ドキュメントが間違っているのはもっての外ですが、さらに可読性が高かったり、機能面においても体験を向上できる要素があります。

そんな中、メンテナンスのしやすさもまた大事な要素になります。今回はMarkdownファイルをベースにしたドキュメントシステム、Docbaseを紹介します。

Docbaseの使い方

利用例です。トップページのデザインも格好良いです。

ドキュメント詳細です。右側に目次、中央にコンテンツが表示されます。

コードは文字が大きく見やすくなっています。

別なドキュメントの例です。ヘッダーやフォントなどをカスタマイズできます。右側のカラムは表示されていません。

DocbaseはMarkdownファイルをベースとしてHTMLを生成します。基本的には2、または3カラムになっており、左に目次が表示されます。機能面はそれほど多くありませんが、可読性が高くて綺麗なのが特徴です。

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

appbaseio/Docbase: Turn .md docs into beautiful sites

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2