create-docs-core
v0.5.1
Published
Scaffold a complete @blaaiz/docs-core documentation site with one command.
Maintainers
Readme
create-docs-core
Scaffold a complete @blaaiz/docs-core documentation site with one command:
pnpm create docs-core my-docs
cd my-docs
pnpm devThat's the whole setup. The generated site already has:
- A landing page at the root — hero in fumadocs' HomeLayout, top bar, no sidebar; swap
app/page.tsxfor a redirect if you'd rather land in the docs - Navigation, search, and a themed layout driven by
content/docs.jsonanddocs.config.ts— Home always means the landing, and section links stay lit across their whole section - A sample API reference with a live try-it playground, backed by a public demo API through the built-in CORS-safe proxy
- Copy page / View as Markdown on every page, plus a plain-text
/mdroute - Agent skills for Claude Code and Codex, installed via
docs-core agents - SEO wiring (metadata, robots, sitemap) and framework error screens
- A first git commit
After that, a site is maintained in exactly three places: MDX pages under content/docs/, navigation in content/docs.json, and brand/features in docs.config.ts. Everything else is the framework's job.
Options
--docs-core <spec> dependency spec for @blaaiz/docs-core (version, tag, or file:… tarball)
--no-install copy files only
--no-git skip git initRequirements
- Node.js 20.11+
- pnpm (the site pins a fumadocs patch that pnpm applies at install time) —
corepack enable pnpm
Related
npx docs-core init— restore missing starter files in an existing sitenpx docs-core agents— refresh the agent skills after upgrading docs-core
