Docker MCP Server

🚀 Dev-Docs 起動テンプレートを使ったクイックスタート

Dev-Docs Docusaurus 起動テンプレートは、ドキュメントを迅速に作成するために設計されています。API、SDK、アプリケーション向けの公開ドキュメントを構築する場合でも、ソフトウェアエンジニアリングチーム向けの内部ドキュメントを作成する場合でも、このテンプレートは堅固な基盤を提供します。

Dev-Docs AI へのテンプレート接続 [重要]

テンプレートの生成に成功しました！ドキュメント作成の旅に乗り出すことを嬉しく思いますが、GitHub アプリをこちらからインストールするのを忘れないでください！

テンプレートの設定

1. リポジトリのクローン：GitHub から Dev-Docs 起動テンプレートのリポジトリをローカルマシンにクローンします。

2. 依存関係のインストールとプロジェクトの起動：プロジェクトディレクトリに移動し、コマンド npm install を実行して必要な依存関係をインストールします。インストールが完了したら、npm run start を実行してプロジェクトを起動します。

3. 内容のカスタマイズ：テンプレートには基本構造といくつかのサンプル内容が用意されており、すぐに始めるのに役立ちます。必要に応じて既存のファイルを変更するか、新しいファイルを作成します。Dev-Docs AI を使用するとドキュメントを自動生成できますし、手動で新しいページを追加することもできます。少なくとも 1 つのページには index マーク（slug）が必要であることを忘れないでください。ドキュメントページに関する詳細情報はこちらで確認できます。

4. テーマの設定：テンプレートはモダンでレスポンシブなテーマを使用しており、デフォルトで使用できますが、プロジェクトのブランドや要件に合わせてスタイルとレイアウトをさらにカスタマイズすることができます。

5. ビルドとプレビュー：提供されているビルドスクリプトを使用して、ドキュメントの静的バージョンを生成します。ほとんどの静的サイトジェネレータには、変更をリアルタイムでプレビューできるローカル開発サーバーも含まれています。

6. デプロイ：ドキュメント内容に満足したら、好みのホスティングプラットフォームにデプロイします。多くの静的サイトジェネレータは、GitHub Pages、Netlify、AWS S3 などの人気のホスティングサービスとシームレスに統合されています。

ファイル構造

Dev-Docs 起動テンプレートは、内容を整理するのに役立つ標準的なファイル構造に従っています。

• docs/：このディレクトリには、通常 Markdown または他のサポートされる静的サイトジェネレータのマークアップ言語で記述されたドキュメントソースファイルが含まれています。
• public/：このディレクトリは、ビルド後に生成される静的 HTML ファイルを保存するために使用されます。
• src/：このディレクトリには、カスタムコンポーネント、プラグイン、またはスクリプトのソースコードが含まれています。
• static/：このディレクトリは、画像、スタイルシート、JavaScript ファイルなどの静的アセットを保存するために使用されます。

カスタマイズと拡張

Dev-Docs 起動テンプレートは高度に拡張可能に設計されており、具体的な要件に合わせてカスタマイズすることができます。

• 新しいページの追加：docs/ ディレクトリに新しい Markdown ファイルを作成して、さらにドキュメントページを追加します。
• 外部サービスの統合：静的サイトジェネレータの拡張性を利用して、外部サービス（検索エンジン、分析ツール、コメントシステムなど）と統合します。
• カスタムコンポーネントの開発：src/ ディレクトリを使用して、カスタム React または Vue コンポーネントなどの再利用可能な要素を開発し、機能とユーザー体験を向上させます。
• テーマの拡張：既存のテーマのスタイルとレイアウトを変更するか、ゼロからカスタムテーマを作成して、プロジェクトのブランドや要件に合わせます。