Skip to content

Commit 2bd664c

Browse files
rsbhclaude
andauthored
fix: pin vite to 8.0.3 and update install docs (#29)
Pin vite to 8.0.3 to avoid npx/bunx compatibility issues with nitro's subpath imports in newer vite versions. Update README to recommend global install instead of bunx, and add CLI build step to contributing guide. Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 4251f37 commit 2bd664c

3 files changed

Lines changed: 57 additions & 11 deletions

File tree

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,7 @@ Config-driven documentation framework built on Vite, Nitro, and Apsara UI.
1616
### Install
1717

1818
```bash
19-
bun add @raystack/chronicle
20-
```
21-
22-
Or run directly without installing:
23-
24-
```bash
25-
bunx @raystack/chronicle init
19+
npm install -g @raystack/chronicle
2620
```
2721

2822
### Initialize
@@ -72,14 +66,26 @@ cd chronicle
7266
bun install
7367
```
7468

75-
3. Run the dev server
69+
3. Build the CLI
70+
71+
```bash
72+
bun run build:cli
73+
```
74+
75+
4. Run the docs site locally
7676

7777
```bash
7878
bun run dev:docs
7979
```
8080

8181
Open [http://localhost:3000](http://localhost:3000) to see the docs site.
8282

83+
You can also run the CLI directly:
84+
85+
```bash
86+
./packages/chronicle/bin/chronicle.js dev --config docs/chronicle.yaml
87+
```
88+
8389
### Making Changes
8490

8591
1. Create a branch from `main`

bun.lock

Lines changed: 42 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/chronicle/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
"slugify": "^1.6.6",
6666
"unified": "^11.0.5",
6767
"unist-util-visit": "^5.1.0",
68-
"vite": "^8.0.0",
68+
"vite": "8.0.3",
6969
"yaml": "^2.8.2",
7070
"zod": "^4.3.6"
7171
}

0 commit comments

Comments
 (0)