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

開発ドキュメントの整備は大きな問題です。ソースコードに書かれたりWikiや何らかのCMSを使ったりと様々な方法がありますが、これといった解決策はなかなか見つけられません。

そこで使ってみたいのがDocusaurusです。Facebook製のオープンソース・ドキュメントサイトです。

Docusaurusの使い方

メインページです。

文書はMarkdownで作成します。

ドキュメント部分です。左側に目次、右側にコンテンツが表示されます。

リンクはページ下に付きます。

DocusaurusのコンテンツはMarkdownとなっています。それだけにメンテナンスが容易です。また、UIはReactで作られていますので、表示が高速に行われます。オープンソースのプロジェクトに最適なドキュメント管理かも知れません。

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

Docusaurus · Easy to Maintain Open Source Documentation Websites

facebook/Docusaurus: Easy to maintain open source documentation websites.

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2