@abstractdata/create-docs
v0.2.4
Published
Scaffold a new branded documentation site using @abstractdata/starlight-theme. Run with `bun create @abstractdata/docs <name>`.
Downloads
66
Maintainers
Readme
@abstractdata/create-docs
One-command scaffolder for new Abstract Data documentation sites.
Usage
bun create @abstractdata/docs my-docs(Or npm create @abstractdata/docs@latest my-docs, or pnpm create @abstractdata/docs my-docs.)
That creates a ./my-docs/ folder with a fresh Starlight project pre-wired to @abstractdata/starlight-theme. Then:
cd my-docs
bun install
bun devWhat it does
- Copies the
@abstractdata/docs-templatefiles into a folder you name. - Sets the project name in
package.jsonandastro.config.mjs. - Replaces the workspace dependency on
@abstractdata/starlight-themewith a real published version range. - Runs
git initand makes an initial commit so you have a clean history from step zero.
After that, edit astro.config.mjs to replace the placeholder site, social, sidebar, and (optionally) logo, then start writing content under src/content/docs/.
Options
For now, bun create @abstractdata/docs <name> is the only invocation. Configuration (motion mode, credit, version chip) is set inside the generated astro.config.mjs after scaffolding — easier to discover than CLI flags.
Maintenance note
The template/ folder ships a copy of packages/template/ from the monorepo. The copy is created automatically by the prepack script before publish — do not hand-edit it. Edit packages/template/ and the copy regenerates on the next publish.
