プロジェクトテンプレートへようこそ
このプロジェクトは新しいドキュメントサイトを作成するためのテンプレートです。scripts/create-project.js
を使用して新しいプロジェクトを作成する際の出発点として設計されています。
このテンプレートについて
このテンプレートには以下の機能が含まれています:
- 多言語対応: 英語と日本語でのコンテンツ作成
- バージョン管理: 複数バージョンの同時管理(必要に応じて追加可能)
- 自動サイドバー: コンテンツ構造に基づく自動ナビゲーション
- 共通UIコンポーネント: 統一されたデザインシステム
- レスポンシブデザイン: すべてのデバイスに対応
プロジェクト構造
src/content/docs/
├── en/ # 英語ドキュメント
│ └── v1/ # 初期バージョン
│ └── 01-guide/ # ガイドセクション
└── ja/ # 日本語ドキュメント
└── v1/
└── 01-guide/
新しいプロジェクトの作成
このテンプレートから新しいプロジェクトを作成する場合:
# 新しいプロジェクトを作成
node scripts/create-project.js my-docs "My Documentation" "私のドキュメント"
# より詳細なオプション付きで作成
node scripts/create-project.js api-docs "API Documentation" "API文書" --icon=code --tags=api,reference
バージョン管理
新しいバージョンが必要になった場合は、scripts/create-version.js
を使用してください:
# 新しいバージョンを追加
node scripts/create-version.js my-docs v2
# インタラクティブモードで追加
node scripts/create-version.js my-docs v2 --interactive
ドキュメントの追加
個別のドキュメントファイルを追加する場合は、scripts/create-document.js
を使用してください:
# 基本的な使用方法
node scripts/create-document.js my-docs ja v1 guide "新しいガイド"
# インタラクティブモードで追加(おすすめ)
node scripts/create-document.js my-docs ja v1 --interactive
カスタマイズのポイント
新しいプロジェクトでは以下をカスタマイズしてください:
- プロジェクト設定:
src/config/project.config.json
を編集 - 表示名: 各言語の
displayName
とdisplayDescription
を更新 - コンテンツ: このテンプレートコンテンツを削除し、プロジェクト固有の内容に置き換え
- カテゴリ: サイドバーのカテゴリをプロジェクトに合わせて調整
開発開始時の手順
- 既存のテンプレートコンテンツを削除または更新
- プロジェクト固有のドキュメントを作成
- 設定ファイルをプロジェクトに合わせて調整
- 開発サーバーでテスト:
pnpm dev
- ビルドテスト:
pnpm build
このテンプレートは新しいドキュメントプロジェクトの基盤として活用してください。