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

開発者に対して見栄えの良いドキュメントを提供する、これはDevRelにおいて大事な要素です。誰だって使いづらい、読みづらいドキュメントは嫌がるものです。デザインはもちろんのこと、文字サイズや見出しの付け方などによっても可読性は変わってきます。

そこで紹介したいのがLaRecipeです。Laravelを使い、Markdownから綺麗なドキュメントを生成してくれるソフトウェアです。

LaRecipeの使い方

デモです。左側に大見出し、中央がコンテンツ、右側にそのページのアウトラインが表示されます。

コードなども綺麗に表示されます。

アウトプットのデモデザインを入れている例。

ドキュメントの下にはコメント欄が用意されています。

左側の目次は非表示にできます。

検索も使えます。

LaRecipeはLaravelを使っており、自分のアプリケーションの中に組み込むこともできます。例えば認証を使ったり、APIを結果を表示するような仕組みも作れるでしょう。Markdownを使いつつも静的ではない利点を活かしたドキュメントが作れそうです。

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

LaRecipe | LaRecipe

saleem-hadad/larecipe: ? Write gorgeous documentations for your products using Markdown inside your Laravel app.

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2