Reference pages state the current interface. Use the task-focused guides when you want rationale or an end-to-end workflow.
Commands, arguments, options, output, and environment escape hatches.
Every top-level tidypress.config.ts surface and its role.
Fields accepted by docs, writing, projects, and pages.
Presentation setup, collection renderers, views, and search providers.
Explicit installation, detection, target directories, and overwrite policy.
Runtime contract
publish root directory required Contains tidypress.config.ts. tidypress init creates site/ by default,
but discovery supports any unambiguous directory containing the config file.
src/content/<collection> directory required Markdown and MDX source. Enabled config collections become typed Astro content collections and route families.
build/ directory required Default static output. It is generated and safe to replace on every build.
~/.cache/tidypress/ directory Generated integration, plugin-manifest, and Astro working data. tidypress clean removes the active project cache.
Package roles
| Package | Public role |
|---|---|
tidypress | Node CLI and the package users install |
@tidypress/config | Typed schema, defaults, normalization, registries |
@tidypress/engine | Astro rendering engine used by the CLI |
@tidypress/astro | Optional integration for projects that own astro.config.mjs |
Python tidypress | Optional notebook conversion and source extraction companion |