Chronicle

Config-driven documentation framework built on Vite, Nitro, and Apsara UI.

Features

• Config-driven — Single chronicle.yaml for all site configuration
• Themeable — Built-in themes: default (sidebar + TOC) and paper (book-style)
• MDX — Write docs in MDX with callouts, tabs, mermaid diagrams, and syntax highlighting
• API docs — Interactive OpenAPI documentation with "Try it out" panel
• LLMs — Auto-generate /llms.txt and /llms-full.txt for AI consumption
• CLI — init, dev, build, start, serve commands

Quick Start

Install

npm install -g @raystack/chronicle

Initialize

chronicle init

Creates a chronicle.yaml and sample index.mdx.

Develop

chronicle dev

Open http://localhost:3000.

Build for production

chronicle build
chronicle start

Contributing

We welcome contributions! Here's how to get started:

Prerequisites

• Node.js >= 22
• Bun >= 1.3

Running Locally

1. Fork and clone the repository

git clone https://github.com/<your-username>/chronicle.git
cd chronicle

2. Install dependencies

bun install

3. Build the CLI

bun run build:cli

4. Run the docs site locally

bun run dev:docs

Open http://localhost:3000 to see the docs site.

You can also run the CLI directly:

./packages/chronicle/bin/chronicle.js dev --config docs/chronicle.yaml

Making Changes

1. Create a branch from main
2. Make your changes
3. Test locally from the docs/ directory
4. Open a pull request

License

Apache-2.0