On this page

TidyPress overview

A publishing framework for turning Git-native work into a coherent public interface.

TidyPress turns a repository into a static public site without asking you to move authorship into a hosted editor. Markdown and configuration stay in git; the build produces the interface readers use.

What it publishes

The publishing contract

  1. Author in the repository

    Write Markdown or MDX under src/content/. Humans and coding agents work through the same files and review process.

  2. Describe the public shape

    tidypress.config.ts defines collections, navigation, branding, theme, integrations, and extension points.

  3. Build one inspectable artifact

    tidypress build emits static HTML, assets, Pagefind search, sitemap data when a production URL is configured, and llms.txt unless disabled.

  4. Ship the folder

    Deploy build/ with TidyPress provider strategies or any static-host workflow.

Where TidyPress is opinionated

TidyPress provides a content graph instead of a blank page generator. Built-in collection kinds distinguish dated writing, projects, pages, and documentation. Starter presets assemble those pieces for common publishing jobs.

The presentation layer remains open. Projects can set tokens and fonts, add CSS and scripts, replace named components, insert stable slots, register MDX primitives, provide custom page layouts, or replace the complete document and route-view boundaries.

Stable defaults

Routing, content validation, navigation, responsive layouts, search, feeds, metadata, and build output work without a theme project.

Explicit ownership

When the baseline no longer fits, override a documented boundary instead of copying an engine layout and inheriting private implementation details.

What is not implied

  • TidyPress is a static publishing framework, not a hosted control plane.
  • It does not currently generate interactive OpenAPI playgrounds. ApiField and ApiResponse are components for hand-authored reference pages.
  • The optional Python package is a notebook/source helper. The Node CLI and Astro engine perform site commands and rendering.
  • Agent skills install only after an explicit tidypress skills install; package installation and ordinary commands never modify agent or shell configuration.

Continue