Configuration File

You can customize Chronoter's behavior by creating a chronoter.config.json file in your project root.

The configuration file is optional. If it doesn't exist, default values will be used.

Basic Configuration Example

chronoter.config.json

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

Configuration Options

site

Configure basic site information.

Property	Type	Default	Description
`title`	string	`"Chronoter Documentation"`	Site title
`description`	string	-	Site description
`baseUrl`	string	-	Site base URL

docsDir

Specify the directory where documentation files are stored.

Type: string
Default: "." (current directory)

theme

Configure the theme settings.

Property	Type	Default	Description
`variant`	string	`"blue"`	Theme color
`logo`	string	-	Path to logo image

Available Theme Colors

blue
slate
violet
green
orange
red
rose
zinc

Define the sidebar navigation structure.

chronoter.config.json

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

ignore

Specify file patterns to ignore during build.

chronoter.config.json

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

Full Configuration Example

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/**"]
}