docbox

REST APIドキュメントを作成するオープンソースのツールです。Markdownファイルから、ナビゲーション付きの2カラム形式のドキュメントを生成します。

Xで共有ライセンス: ISC

概要

Docboxは、REST APIドキュメントを作るためのオープンソースの仕組みです。構造化したMarkdownを書くと、左に説明、右に例を並べた2カラムのサイトが生成され、ナビゲーションやパーマリンクも付きます。ReactアプリでMarkdownの解析にremarkを使います。元ファイルに表示用のコードは含まれず、ビルドで公開用に整えます。

主な特長

  • 構造化Markdownから2カラムのドキュメントサイトを生成
  • ナビゲーションとパーマリンクを自動作成
  • リンク切れや不正な例、構成の問題をテストで検出
  • 文書内のJavaScript例を抽出してeslintで検査

こんな人・用途に

APIドキュメントをMarkdownのまま管理し、自動チェックで一貫性を保ちたいチーム向けです。

アップストリーム
mapillary/docbox
GitHubのフォーク
Guo-astro/docbox
アップストリームのスター数
1
カテゴリ
ドキュメント・メディア・コンテンツ
ライセンス
ISC
フォーク日
2020-12-06
同期状態
同期済み最終同期 2026-09-29

同じカテゴリ: ドキュメント・メディア・コンテンツ