Skip to content
Merged
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
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,11 @@ bite in this repo:
The docs live in `website/` (Qwik Router, built as static pages): `pnpm -C website dev` runs it, and
`pnpm build.website` builds the library and the site as Vercel does. The props, data attributes,
headless parts and `useCalendar()` fields are data in `website/src/data/`: the pages, the search and
`llms-full.txt` read them. After changing them, or the use cases in `website/scripts/llms-full.md`,
run `pnpm -C website llms` to write `website/public/llms-full.txt` again.
`llms-full.txt` read them. `llms.txt` and `llms-full.txt` (from `website/scripts/llms.md` and
`llms-full.md`) aren't in the repo: `pnpm build.website` writes them; for `pnpm -C website dev`, run
`pnpm -C website llms` first. The versions the site shows (the version menu, the install commands, the
changelog's dates) come from npm when it builds (`website/src/data/npm.ts`): nothing to change when a
version comes out.

Vercel hosts it. Production deploys from GitHub Actions (`.github/workflows/website.yml`): after each
release, once the new version is on npm, and on each push to `main` that changes `website/` or
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"type": "module",
"scripts": {
"build": "qwik build",
"build.website": "pnpm build.types && pnpm build.lib && pnpm -C website build.client && pnpm -C website build.server",
"build.website": "pnpm build.types && pnpm build.lib && pnpm -C website llms && pnpm -C website build.client && pnpm -C website build.server",
"build.lib": "vite build --mode lib",
"build.types": "tsc --emitDeclarationOnly -p ./tsconfig.lib.json",
"dev": "vite --mode ssr",
Expand Down
4 changes: 4 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,7 @@ lerna-debug.log*
# Yarn
.yarn/*
!.yarn/releases

# written by scripts/llms.ts when the site builds
/public/llms.txt
/public/llms-full.txt
2 changes: 1 addition & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"fmt": "prettier --write .",
"fmt.check": "prettier --check .",
"lint": "biome check --write --unsafe",
"llms": "node scripts/llms-full.ts",
"llms": "node scripts/llms.ts",
"preview": "qwik build preview && vite preview --open",
"start": "vite --open --mode ssr",
"qwik": "qwik"
Expand Down
Loading
Loading