tidypress
On this page

Examples

Runnable example projects for common TidyPress shapes.

The repository keeps focused examples under examples/.

Use the examples when you want to see one site shape without the full product documentation site.

Minimal

pnpm --filter @tidypress/example-minimal build

examples/minimal is the smallest runnable project. It mirrors the default tidypress init shape:

examples/minimal/docs/
├── tidypress.config.ts
└── src/content/
    ├── docs/getting-started.md
    └── writing/hello.md

Use it to test the basic docs + writing flow.

Lab

pnpm --filter @tidypress/example-lab build

examples/lab matches tidypress init (lab preset): writing and projects on the home page, docs off.

Blog

pnpm --filter @tidypress/example-blog build

examples/blog matches tidypress init --preset blog: writing only; docs, projects, and pages off.

Persona

pnpm --filter @tidypress/example-persona build

examples/persona matches tidypress init --preset persona: opt-in hero, projects, writing, and an about page.

i18n and versions

pnpm --filter @tidypress/example-i18n-versioned build

examples/i18n-versioned shows:

  • latest docs at /docs
  • archived docs at /docs/v1
  • French routes under /fr
  • default-locale content without an en/ folder

Custom collections

pnpm --filter @tidypress/example-custom-collections build

examples/custom-collections adds a playbooks collection:

collections: {
  playbooks: {
    enabled: true,
    basePath: '/playbooks',
    kind: 'content',
    label: 'playbooks',
  },
}

Use this when docs and writing are not enough for the shape of your site.

Product docs site

apps/site is the full TidyPress site. It is useful as a larger dogfood fixture, but the focused examples are better starting points for copying.