{"id":21185609,"url":"https://github.com/raystack/chronicle","last_synced_at":"2026-04-20T10:07:30.663Z","repository":{"id":175211379,"uuid":"645123728","full_name":"raystack/chronicle","owner":"raystack","description":null,"archived":false,"fork":false,"pushed_at":"2026-04-15T10:32:44.000Z","size":891,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-15T12:21:53.756Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raystack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-05-25T01:25:45.000Z","updated_at":"2026-04-14T09:25:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"6abe297e-af80-4607-adc5-8a18dcc6e1c7","html_url":"https://github.com/raystack/chronicle","commit_stats":null,"previous_names":["raystack/chronicle"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/raystack/chronicle","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raystack%2Fchronicle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raystack%2Fchronicle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raystack%2Fchronicle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raystack%2Fchronicle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raystack","download_url":"https://codeload.github.com/raystack/chronicle/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raystack%2Fchronicle/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32042360,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T00:18:06.643Z","status":"online","status_checked_at":"2026-04-20T02:00:06.527Z","response_time":94,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-20T18:17:19.169Z","updated_at":"2026-04-20T10:07:30.643Z","avatar_url":"https://github.com/raystack.png","language":"TypeScript","readme":"# Chronicle\n\nConfig-driven documentation framework built on Vite, Nitro, and Apsara UI.\n\n## Features\n\n- **Config-driven** — Single `chronicle.yaml` for all site configuration\n- **Themeable** — Built-in themes: `default` (sidebar + TOC) and `paper` (book-style)\n- **MDX** — Write docs in MDX with callouts, tabs, mermaid diagrams, and syntax highlighting\n- **API docs** — Interactive OpenAPI documentation with \"Try it out\" panel\n- **LLMs** — Auto-generate `/llms.txt` and `/llms-full.txt` for AI consumption\n- **CLI** — `init`, `dev`, `build`, `start`, `serve` commands\n\n## Quick Start\n\n### Install\n\n```bash\nnpm install -g @raystack/chronicle\n```\n\n### Initialize\n\n```bash\nchronicle init\n```\n\nCreates a `chronicle.yaml` and sample `index.mdx`.\n\n### Develop\n\n```bash\nchronicle dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000).\n\n### Build for production\n\n```bash\nchronicle build\nchronicle start\n```\n\n## Contributing\n\nWe welcome contributions! Here's how to get started:\n\n### Prerequisites\n\n- [Node.js](https://nodejs.org/) \u003e= 22\n- [Bun](https://bun.sh/) \u003e= 1.3\n\n### Running Locally\n\n1. Fork and clone the repository\n\n```bash\ngit clone https://github.com/\u003cyour-username\u003e/chronicle.git\ncd chronicle\n```\n\n2. Install dependencies\n\n```bash\nbun install\n```\n\n3. Build the CLI\n\n```bash\nbun run build:cli\n```\n\n4. Run the docs site locally\n\n```bash\nbun run dev:docs\n```\n\nOpen [http://localhost:3000](http://localhost:3000) to see the docs site.\n\nYou can also run the CLI directly:\n\n```bash\n./packages/chronicle/bin/chronicle.js dev --config docs/chronicle.yaml\n```\n\n### Making Changes\n\n1. Create a branch from `main`\n2. Make your changes\n3. Test locally from the `docs/` directory\n4. Open a pull request\n\n## License\n\n[Apache-2.0](LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraystack%2Fchronicle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraystack%2Fchronicle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraystack%2Fchronicle/lists"}