設定ファイル

プロジェクトルートに chronoter.config.json を作成することで、Chronoterの動作をカスタマイズできます。

設定ファイルはオプションです。存在しない場合はデフォルト値で動作します。

基本的な設定例

chronoter.config.json

{
  "site": {
    "title": "My Documentation",
    "description": "Documentation for my project"
  },
  "docsDir": "docs"
}

設定項目

site

サイトの基本情報を設定します。

プロパティ	型	デフォルト	説明
`title`	string	`"Chronoter Documentation"`	サイトのタイトル
`description`	string	-	サイトの説明
`baseUrl`	string	-	サイトのベースURL

docsDir

ドキュメントファイルが格納されているディレクトリを指定します。

型: string
デフォルト: "."（カレントディレクトリ）

theme

テーマの設定を行います。

プロパティ	型	デフォルト	説明
`variant`	string	`"blue"`	テーマカラー
`logo`	string	-	ロゴ画像のパス

利用可能なテーマカラー

blue
slate
violet
green
orange
red
rose
zinc

サイドバーのナビゲーション構造を定義します。

chronoter.config.json

{
  "navigation": [
    {
      "title": "Getting Started",
      "items": [
        { "title": "Introduction", "path": "/introduction" },
        { "title": "Quick Start", "path": "/quickstart" }
      ]
    }
  ]
}

ignore

ビルド時に無視するファイルパターンを指定します。

chronoter.config.json

{
  "ignore": ["drafts/**", "*.draft.mdx"]
}

完全な設定例

chronoter.config.json

{
  "site": {
    "title": "My Project Docs",
    "description": "Documentation for My Project",
    "baseUrl": "https://docs.example.com"
  },
  "docsDir": "docs",
  "theme": {
    "variant": "violet",
    "logo": "/images/logo.svg"
  },
  "navigation": [
    {
      "title": "Guide",
      "items": [
        { "title": "Introduction", "path": "/introduction" },
        { "title": "Installation", "path": "/installation" }
      ]
    }
  ],
  "ignore": ["drafts/**"]
}