クイックスタート

このガイドでは、Chronoterを使ってドキュメントサイトを作成し、Platformにデプロイするまでの流れを説明します。

1. CLIのインストール

npm install -g chronoter

インストールを確認します：

chronoter --version

2. プロジェクトの作成

新しいディレクトリを作成し、設定ファイルを追加します：

mkdir my-docs
cd my-docs

chronoter.config.json を作成します：

{
  "site": {
    "title": "My Docs",
    "description": "チームのドキュメント"
  }
}

3. 最初のドキュメントを作成

index.mdx を作成します：

---
title: Welcome
description: ドキュメントへようこそ
---
 
# Welcome
 
これは最初のドキュメントです。
 
## 特徴
 
- **MDX対応**: Markdown + JSXで記述
- **高速プレビュー**: 変更を即座に確認
- **AIフレンドリー**: 構造化されたコンテキスト

4. 開発サーバーの起動

chronoter dev

ブラウザで http://localhost:5173 を開くと、ドキュメントが表示されます。

ファイルを編集すると、ブラウザに即座に反映されます。

5. GitHubリポジトリの準備

Platformにデプロイするには、GitHubリポジトリが必要です：

git init
git add .
git commit -m "Initial commit"
git remote add origin https://github.com/your-org/my-docs.git
git push -u origin main

6. Platformへのデプロイ

  1. Chronoter Platform にアクセス
  2. 招待コードを入力してアカウントを作成
  3. OrganizationとProjectを作成
  4. GitHubリポジトリを連携

連携が完了すると、pushのたびに自動でドキュメントが更新されます。

次のステップ