Getting Started with the Dev-Docs Starter Template

Dev-Docs Starter Templateを使い始める

Dev-Docs Docusaurusスターターテンプレートは、独自のドキュメントをすばやく簡単に作成できるよう設計されています。API、SDK、アプリケーション向けの一般公開ドキュメントを作成する場合も、ソフトウェアエンジニアリング組織向けの社内ドキュメントを作成する場合も、このテンプレートを基盤としてすぐに作業を始められます。これはDocusaurusテンプレートであり、同じ機能の大部分、またはすべてを維持する必要があります。

このテンプレートとDev-Docs AIの接続を完了する [重要]

テンプレートの生成おめでとうございます。ドキュメント作成の次のステップも楽しみですね。ただし、こちらからGitHub Appをインストールするのをお忘れなく！

テンプレートのセットアップ

1. リポジトリをクローンする：まず、Dev-Docsスターターテンプレートのリポジトリをローカルマシンにクローンします。

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

3. コンテンツをカスタマイズする：このテンプレートには、すぐに作業を始められるよう、基本的な構成とサンプルコンテンツが用意されています。既存のファイルを変更するか、新しいファイルを作成して、必要なドキュメントに合わせてください。作業を簡単にするには、このテンプレートでDev-Docs AIを使ってドキュメントを自動生成するか、新しいページを手動で追加できます。少なくとも1つのページには、インデックススラッグが必要です。ドキュメントページについて詳しくはこちらをご覧ください。

4. テーマを設定する：このテンプレートには、モダンでレスポンシブなテーマが標準で用意されていますが、プロジェクトのブランディングや要件に合わせて、スタイルやレイアウトを変更し、さらにカスタマイズできます。

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

6. デプロイする：ドキュメントの準備ができたら、お好みのホスティングプラットフォームにデプロイします。多くの静的サイトジェネレーターは、GitHub Pages、Netlify、AWS S3などの一般的なホスティングサービスとシームレスに連携できます。

フォルダー構成

Dev-Docsスターターテンプレートは、コンテンツを整理しやすい標準的なフォルダー構成を採用しています。

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

カスタマイズと拡張性

Dev-Docs スターターテンプレートは拡張性を考慮して構築されているため、ニーズに合わせてカスタマイズ、強化できます。以下のことができます。

• 新しいページを追加する：docs/ ディレクトリに新しい Markdown ファイルを作成して、ドキュメントにページを追加できます。
• 外部サービスと統合する：選択した静的サイトジェネレーターの拡張性を活用して、検索エンジン、分析ツール、コメントシステムなどの外部サービスと統合できます。
• カスタムコンポーネントを開発する：src/ ディレクトリを使用して、カスタムの React コンポーネント、Vue コンポーネント、またはその他の再利用可能な要素を開発し、ドキュメントの機能とユーザーエクスペリエンスを向上させることができます。
• テーマを強化する：用意されている CSS ファイルやテンプレートファイルを編集して既存のテーマスタイルやレイアウトを変更するか、独自のカスタムテーマを一から作成できます。

Dev-Docs スターターテンプレートを活用すれば、ドキュメントプロジェクトをすぐに始められます。最新の静的サイトジェネレーターの柔軟性と拡張性を活用しながら、高品質なコンテンツの作成に専念できます。