Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/basic/chronicle.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ content:
label: Docs

theme:
name: default
name: paper

search:
enabled: true
Expand Down
10 changes: 9 additions & 1 deletion examples/versioned/chronicle.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,21 @@ site:
description: Multi-content + multi-version sample

theme:
name: default
name: paper

content:
- dir: docs
label: Docs
description: A reference manual for the core platform and services. Covers authentication, data models, API integrations, deployment guides, and troubleshooting. Everything you need to get started with the platform and build production-ready applications.
- dir: dev
label: Dev Docs
description: Developer guides for building integrations and extensions
- dir: ops
label: Ops Guide
description: Operations handbook for deployment, monitoring, and incident response
- dir: design
label: Design System
description: Component library documentation, design tokens, and usage patterns

latest:
label: "3.0"
Expand Down
7 changes: 7 additions & 0 deletions examples/versioned/content/design/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Design System
description: Component library docs
order: 1
---

Design system documentation placeholder.
83 changes: 83 additions & 0 deletions examples/versioned/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,86 @@ order: 1
# Docs — latest

This is `/docs` on latest (3.0).

## Getting Started

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

## Installation

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.

```bash
npm install @raystack/chronicle
```

Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt.

## Configuration

At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident.

```yaml
site:
title: My Documentation
description: Powered by Chronicle

theme:
name: paper
```

Similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio.

## Usage

Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus.

Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus.

## Advanced Topics

Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur. Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur.

### Theming

Vel illum qui dolorem eum fugiat quo voluptas nulla pariatur. At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti.

### Plugins

Quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga.

## API Reference

Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus.

Omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae.

## Troubleshooting

Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium.

## Deployment

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

## Security

At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident.

Similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio.

## Performance

Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus.

Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur. Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse.

## Migration Guide

Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet.

Consectetur adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis.
7 changes: 7 additions & 0 deletions examples/versioned/content/ops/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Ops Guide
description: Operations handbook
order: 1
---

Operations documentation placeholder.
18 changes: 11 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
{
"name": "chronicle",
"private": true,
"workspaces": [
"packages/*",
"examples/*"
],
"dependencies": {
"std-env": "^4.0.0"
},
"engines": {
"node": ">=22"
},
"private": true,
"scripts": {
"build:cli": "bun run --filter @raystack/chronicle build:cli",
"dev:docs": "./packages/chronicle/bin/chronicle.js dev --config docs/chronicle.yaml",
Expand All @@ -18,7 +17,12 @@
"dev:examples:versioned": "./packages/chronicle/bin/chronicle.js dev --config examples/versioned/chronicle.yaml",
"build:examples:versioned": "./packages/chronicle/bin/chronicle.js build --config examples/versioned/chronicle.yaml"
},
"dependencies": {
"std-env": "^4.0.0"
"workspaces": [
"packages/*",
"examples/*"
],
"devDependencies": {
"@raystack/chronicle": "workspace:*",
"remark-reading-time": "^2.1.0"
}
}
5 changes: 5 additions & 0 deletions packages/chronicle/src/lib/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ export interface ContentRoot {
versionLabel: string | null
contentDir: string
contentLabel: string
contentDescription?: string
contentIcon?: string
fsPath: string
urlPrefix: string
Expand All @@ -46,6 +47,7 @@ export function getLatestContentRoots(config: ChronicleConfig): ContentRoot[] {
versionLabel: config.latest?.label ?? null,
contentDir: c.dir,
contentLabel: c.label,
contentDescription: c.description,
contentIcon: c.icon,
fsPath: `content/${c.dir}`,
urlPrefix: `/${c.dir}`,
Expand All @@ -64,6 +66,7 @@ export function getVersionContentRoots(
versionLabel: version.label,
contentDir: c.dir,
contentLabel: c.label,
contentDescription: c.description,
contentIcon: c.icon,
fsPath: `versions/${version.dir}/${c.dir}`,
urlPrefix: `/${version.dir}/${c.dir}`,
Expand All @@ -79,6 +82,7 @@ export interface VersionDescriptor {

export interface LandingEntry {
label: string
description?: string
href: string
contentDir: string
icon?: string
Expand All @@ -95,6 +99,7 @@ export function getLandingEntries(

return roots.map((r) => ({
label: r.contentLabel,
description: r.contentDescription,
href: r.urlPrefix,
contentDir: r.contentDir,
icon: r.contentIcon,
Expand Down
15 changes: 12 additions & 3 deletions packages/chronicle/src/lib/source.ts
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ export function extractFrontmatter(page: { data: unknown }, fallbackTitle?: stri
order: d.order as number | undefined,
icon: d.icon as string | undefined,
lastModified: d.lastModified as string | undefined,
_readingTime: d._readingTime as number | undefined,
};
}

Expand All @@ -217,13 +218,20 @@ export function getOriginalPath(page: { data: unknown }): string {
return ((page.data as Record<string, unknown>)._originalPath as string) ?? '';
}

const ssrModules = import.meta.glob<{ default?: MDXContent; toc?: TableOfContents }>(
interface ReadingTime {
text: string;
minutes: number;
words: number;
time: number;
}

const ssrModules = import.meta.glob<{ default?: MDXContent; toc?: TableOfContents; readingTime?: ReadingTime }>(
'../../.content/**/*.{mdx,md}'
);

export async function loadPageModule(
relativePath: string
): Promise<{ default: MDXContent | null; toc: TableOfContents }> {
): Promise<{ default: MDXContent | null; toc: TableOfContents; _readingTime?: number }> {
if (!relativePath || relativePath.includes('..')) return { default: null, toc: [] };
const withoutExt = relativePath.replace(/\.(mdx|md)$/, '');
const key = relativePath.endsWith('.md')
Expand All @@ -232,5 +240,6 @@ export async function loadPageModule(
const loader = ssrModules[key];
if (!loader) return { default: null, toc: [] };
const mod = await loader();
return { default: mod.default ?? null, toc: mod.toc ?? [] };
const minutes = mod.readingTime?.minutes;
return { default: mod.default ?? null, toc: mod.toc ?? [], _readingTime: minutes != null ? Math.max(1, Math.round(minutes)) : undefined };
}
Loading
Loading