tidypress
On this page

Body of work

Works, projects, writing, reference, process, and pages — product docs use the docs collection separately.

TidyPress models a public body of work with collection keys and built-in kinds. The body-of-work preset is generated from publicationSurfaceDefinitions in @tidypress/config — six surfaces, not product docs.

Quick start

npx tidypress init --preset body-of-work --site-url https://yoursite.example

For work and product documentation in one site:

npx tidypress init --preset body-of-work-docs --site-url https://yoursite.example
KeyKindPurpose
worksprojectsCase studies, major artifacts
projectsprojectsRepos, apps, tools, experiments
writingwritingEssays, technical notes
referencecontentAPI, config, CLI reference in the docs sidebar shell
processcontentADRs, decisions, build logs
pagespageAbout, now, contact, uses, resume

The homepage shows works, projects, and writing. Reference and process link from the footer, not the header, so mobile nav stays readable. Add them to home.order to surface them on the home page.

Product docs

The docs collection is sidebar-ordered product documentation — tutorials, how-tos, and guides. The default body-of-work preset disables it; use body-of-work-docs or docs-writing to enable it from init.

npx tidypress init --preset body-of-work-docs

Or enable collections.docs later and add content under src/content/docs/.

siteUrl

Set siteUrl in tidypress.config.ts before deploy. Until then, canonical URLs, Open Graph, RSS, and the sitemap use the placeholder host. tidypress doctor and tidypress build remind you when it is still unset.

Reference vs docs

SurfaceUse for
docsTeaching and product documentation
referenceFacts: API, config, CLI
processDecisions: ADRs, roadmaps

Set featured: true in frontmatter for writing and projects-kind collections (including a works key).