Getting Started ¶

Install ¶

npm install --save-dev @markup-carve/carve-press

Initialize ¶

npx carve-press init

Use --force only when you intentionally want scaffold files overwritten.

Project Layout ¶

carve-press.config.ts
docs/
  index.crv
  guide/
    getting-started.crv
public/
  .gitkeep

The default source directory is docs, the default output directory is dist, and both can be changed in Configuration.

First Build ¶

npx carve-press build

The build discovers pages, expands includes, renders Carve through the extension stack, validates navigation and links, then writes static files.

Dev Server ¶

npx carve-press dev --open

The dev server rebuilds on content and config changes. To preview an existing build, run:

npx carve-press serve --port 4173

Next, read Writing Content for frontmatter, includes, and cross-reference rules.