DocsBuild
Settings for Vite, Astro, Next and plain HTML
The install command, build command and output directory for the tools people bring here most often. Copy the row for yours.
| Framework | Install | Build | Output |
|---|---|---|---|
| Vite (React, Vue, Svelte) | npm ci | npm run build | dist |
| Astro | npm ci | npm run build | dist |
| Next.js, static export | npm ci | npm run build | out |
| Create React App | npm ci | npm run build | build |
| SvelteKit, static adapter | npm ci | npm run build | build |
| Eleventy | npm ci | npm run build | _site |
| Plain HTML | leave empty | leave empty | . |
Next.js needs one line of config
Next.js builds a server by default, and ChimeLab serves static files. Tell it to export instead, in next.config.ts:
const nextConfig = {
output: "export",
images: { unoptimized: true },
};The image line is there because the image optimiser needs a running server. With both set, npm run build writes a folder called out, which is what goes in the output directory field.
SvelteKit needs the static adapter
Install @sveltejs/adapter-static and set it in svelte.config.js. Without it, SvelteKit builds a Node server that ChimeLab has nowhere to run.
Plain HTML
A repository of index.html and a stylesheet needs no install and no build. Leave both commands empty and set the output directory to a single dot, which means the repository root. Every file in it is published as it is.
Something else
Anything that ends with a folder of HTML, CSS and JavaScript will work, whatever produced it. Set the commands your own README tells contributors to run, and the folder those commands create.