Doctave

Doctaveは、Markdownでの柔軟な執筆とプロフェッショナルなドキュメントホスティングの強力な機能を組み合わせたドキュメンテーションプラットフォームです。ドキュメントはプレーンテキストファイルで作成し、コードと一緒にGitに保存します。Doctaveがそれらを美しく検索可能なドキュメントウェブサイトに変換します。

このプラットフォームは、通常のMarkdownガイドとAPIドキュメント用のOpenAPI仕様の両方をサポートしています。変更を加えると自動的にプレビュー環境を作成し、チームが公開前に更新内容を確認できます。すべてがGitリポジトリ内に保持されるため、ドキュメントのバージョン管理を完全に行えます。

Doctave Studioは、リアルタイムプレビュー、自動補完提案、リンク切れチェック、スペルチェックを提供するデスクトップの補助アプリケーションです。これらのツールが連携して、チームが最新かつ正確なドキュメントを作成するのを支援します。

Doctaveの使い始めは簡単です。効果的に使う方法は以下の通りです：

• コードリポジトリ内にドキュメント用のフォルダを作成し、Markdownファイルでコンテンツを作成します。README.mdファイルを開始ページとして含めてください。

• Doctave Studioをコンピュータにインストールし、執筆中にリアルタイムで更新されるドキュメントをローカルでプレビューします。

• doctave.yml設定ファイルをセットアップして、ドキュメントの構造、テーマカラー、ナビゲーションリンクを定義します。

• GitリポジトリをDoctaveのプラットフォームに接続します。変更をプッシュするたびに、Doctaveが公開中のドキュメントを自動的に更新します。

• APIドキュメントの場合は、OpenAPI仕様ファイルをリポジトリに追加します。Doctaveが自動的にインタラクティブなAPIリファレンスページを生成します。

• Gitブランチを使ってドキュメントの異なるバージョンを管理します。変更を公開する前にプルリクエストを作成してレビューし、Doctaveが各プルリクエストのプレビューページリンクを生成します。

• バージョン管理対応のGitベースドキュメントワークフロー

• リアルタイムプレビュー機能付きDoctave Studioデスクトップエディター

• APIドキュメント向けOpenAPI仕様サポート

• プルリクエスト用の自動プレビュー環境

• マルチバージョンドキュメント管理

• 全コンテンツを対象とした組み込み検索機能

• カスタムブランディングおよびテーマ設定オプション

• 読者分析とフィードバック収集

• 自動デプロイのためのCI/CD統合

• パスワード保護されたドキュメントオプション