star7th/showdoc

これは何？

主な機能

• 01APIインターフェースとデータディクショナリのテンプレートを内蔵し、ページをすばやく作成できます。
• 02ページごとのバージョン履歴に対応したMarkdownエディター。
• 03公開・非公開プロジェクト、メンバー管理、所有者の変更に対応。
• 04デスクトップとモバイルで閲覧しやすいレスポンシブレイアウト。
• 05プロジェクトをオフラインで閲覧できるWord文書としてエクスポート。
• 06自社サーバーにセルフホスト可能。

ユースケース

• フロントエンドやモバイルの開発者が利用できるよう、バックエンドAPIを文書化する。
• すべてのフィールドを説明するデータベースのデータディクショナリを管理する。
• チーム向けに社内ツールの操作手順や技術仕様書を作成する。
• 文書化されていないレガシープロジェクトを引き継ぐ。

クイックスタート

1. 1

   AutoInstallガイドに従って、自分のサーバーにデプロイします

使う前に知っておきたいこと

• !セルフホスティングが必要です。NginxまたはApacheを使用する場合は、セキュリティのためSqlite/ディレクトリへのアクセスを拒否する必要があります。
• !メタデータではライセンスがNOASSERTIONと記載されています。また、READMEにはApache 2.0を超える著作権条項が追加されており、UIに著作権表示とリンクを残す必要があります。

収録されている特集

トピック

よくある質問

showdoc とは？

APIドキュメント、データディクショナリ、MarkdownベースのチームWikiに対応した、ITチーム向けのセルフホスト型ドキュメントツール。 ShowDocは、ソフトウェアチーム向けのWebベースのドキュメント共有ツールです。最新のドキュメントがないと、ある人が書いたコードを他の人が引き継ぐのは困難です。また、Wordファイルやチャットに散在するドキュメントは、すぐに古くなってしまいます。ShowDocは、こうしたよくある課題を解決します。

showdoc は無料で使えますか？ライセンスは？

showdoc は Other ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

showdoc は今もメンテナンスされていますか？

活発にメンテナンス中。showdoc の最終コミットは 2026年11月3日 です。

showdoc は何に使えますか？

フロントエンドやモバイルの開発者が利用できるよう、バックエンドAPIを文書化する。 すべてのフィールドを説明するデータベースのデータディクショナリを管理する。 チーム向けに社内ツールの操作手順や技術仕様書を作成する。 文書化されていないレガシープロジェクトを引き継ぐ。

showdoc のインストール方法は？

AutoInstallガイドに従って、自分のサーバーにデプロイします

showdoc はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/star7th/showdoc