# ciderpress

> Beautiful Docs, Zero Effort

## Getting Started

- [Introduction](https://ciderpress.dev/getting-started/introduction.md): What ciderpress is, why it exists, and what it gives you out of the box.

## Concepts

- [Content](https://ciderpress.dev/concepts/content.md): How pages define your site structure — one unified Page shape for leaves, groups, and auto-discovered sections, with glob discovery, inline content, and default frontmatter injection.

## Guides

- [Deploy to Vercel](https://ciderpress.dev/guides/deploying-to-vercel.md): Build and deploy your ciderpress site to Vercel's static hosting.

## Framework

- [Overview](https://ciderpress.dev/framework/overview.md): ciderpress's opinionated take on documentation organization, inspired by Diataxis.

## Reference

- [Configuration](https://ciderpress.dev/reference/configuration.md): Complete reference for ciderpress.config.ts — every top-level key, every shape, every primitive.

## Others

- [Changelog](https://ciderpress.dev/changelog.md): All notable changes to ciderpress packages, aggregated by release version.
- [Concepts](https://ciderpress.dev/concepts.md): Core ideas behind how ciderpress organizes and renders documentation.
- [LLM Output](https://ciderpress.dev/concepts/llm-output.md): How ciderpress serves documentation as structured text for LLMs, AI agents, and programmatic consumers.
- [Navigation](https://ciderpress.dev/concepts/navigation.md): How the topbar, sidebar, and auto-generated landing pages control how users find and arrive at content.
- [Publishing](https://ciderpress.dev/concepts/publishing.md): How Ciderpress makes a deployed documentation site discoverable by browsers, search engines, social platforms, and AI tools.
- [Themes](https://ciderpress.dev/concepts/themes.md): How built-in themes, dark/light variants, theme + variant switchers, and color token overrides shape the visual identity of your documentation site.
- [Workspaces](https://ciderpress.dev/concepts/workspaces.md): How workspaces drive the home-page showcase, landing-page cards, and monorepo organization.
- [Contributing](https://ciderpress.dev/contributing.md): Welcome to the ciderpress contributing docs. This directory contains standards, templates, and guides for working in this codebase.
- [Concepts](https://ciderpress.dev/contributing/concepts.md)
- [Architecture](https://ciderpress.dev/contributing/concepts/architecture.md): High-level overview of how ciderpress is structured, its design philosophy, and how data flows through the system.
- [Config](https://ciderpress.dev/contributing/concepts/config.md): The single source of truth for the entire documentation site.
- [Engine](https://ciderpress.dev/contributing/concepts/engine.md)
- [Dev Mode](https://ciderpress.dev/contributing/concepts/engine/dev.md): The watch loop that powers ciderpress dev -- file watching, incremental resyncs, and Rspress hot reload.
- [Incremental Sync](https://ciderpress.dev/contributing/concepts/engine/incremental.md): Manifest-based skip logic that makes ciderpress dev fast after the initial sync.
- [OpenAPI Sync](https://ciderpress.dev/contributing/concepts/engine/openapi.md): Transforms OpenAPI specs into browsable MDX pages with interactive components.
- [Engine](https://ciderpress.dev/contributing/concepts/engine/overview.md): The materialization layer that transforms ciderpress.config.ts into a Rspress-compatible documentation site.
- [Pipeline](https://ciderpress.dev/contributing/concepts/engine/pipeline.md): The sync pipeline that transforms config into content.
- [Guides](https://ciderpress.dev/contributing/guides.md)
- [Develop a Feature](https://ciderpress.dev/contributing/guides/developing-a-feature.md): Ship a feature end-to-end: branch, code, test, changeset, PR, and merge.
- [Get Started Contributing](https://ciderpress.dev/contributing/guides/getting-started.md): Set up your local environment to contribute to ciderpress.
- [Publishing the VS Code Extension](https://ciderpress.dev/contributing/guides/publishing-vscode-extension.md): Steps to publish a new version of the ciderpress-vscode extension to the VS Code Marketplace.
- [References](https://ciderpress.dev/contributing/references.md)
- [CLI Reference](https://ciderpress.dev/contributing/references/cli.md): Command syntax, flags, and Rspress integration for the ciderpress CLI.
- [Standards](https://ciderpress.dev/contributing/standards.md)
- [Documentation](https://ciderpress.dev/contributing/standards/documentation.md)
- [Diagram Standards](https://ciderpress.dev/contributing/standards/documentation/diagrams.md)
- [Documentation Formatting Standards](https://ciderpress.dev/contributing/standards/documentation/formatting.md)
- [Documentation Writing Standards](https://ciderpress.dev/contributing/standards/documentation/writing.md)
- [Git](https://ciderpress.dev/contributing/standards/git.md)
- [Commit Standards](https://ciderpress.dev/contributing/standards/git/git-commits.md)
- [Pull Request Standards](https://ciderpress.dev/contributing/standards/git/git-pulls.md)
- [Typescript](https://ciderpress.dev/contributing/standards/typescript.md)
- [Coding Style](https://ciderpress.dev/contributing/standards/typescript/coding-style.md): High-level constraints that govern all TypeScript in the monorepo. Enforced by OXLint and OXFmt.
- [Conditionals and Branching](https://ciderpress.dev/contributing/standards/typescript/conditionals.md)
- [Design Patterns](https://ciderpress.dev/contributing/standards/typescript/design-patterns.md)
- [Error Handling](https://ciderpress.dev/contributing/standards/typescript/errors.md): The project uses two different Result shapes — know which one you are touching. Public-facing functions return the tuple form. The object form only appears at the boundary where massaman's attemptAsync is called.
- [Function Standards](https://ciderpress.dev/contributing/standards/typescript/functions.md)
- [Naming Conventions](https://ciderpress.dev/contributing/standards/typescript/naming.md)
- [State Management](https://ciderpress.dev/contributing/standards/typescript/state.md)
- [Testing Standards](https://ciderpress.dev/contributing/standards/typescript/testing.md)
- [Type Patterns](https://ciderpress.dev/contributing/standards/typescript/types.md)
- [Utilities (massaman/*)](https://ciderpress.dev/contributing/standards/typescript/utilities.md)
- [Examples](https://ciderpress.dev/examples.md): Live example sites built with ciderpress.
- [Framework](https://ciderpress.dev/framework.md): An opinionated approach to documentation organization, inspired by Diataxis.
- [Recommended](https://ciderpress.dev/framework/recommended.md): The recommended layout for a ciderpress documentation site.
- [Scaling](https://ciderpress.dev/framework/scaling.md): How to evolve your documentation structure as your project grows.
- [Templates](https://ciderpress.dev/framework/templates.md): Starter templates for each documentation type.
- [Concept Template](https://ciderpress.dev/framework/templates/concept.md): Copy-paste template for writing concept (explanation) documentation.
- [Guide Template](https://ciderpress.dev/framework/templates/guide.md): Copy-paste template for writing how-to guide documentation.
- [Types](https://ciderpress.dev/framework/types.md): The eight documentation types and when to use each one.
- [Getting Started](https://ciderpress.dev/getting-started.md): Set up ciderpress and ship your first documentation site in minutes.
- [Quick Start](https://ciderpress.dev/getting-started/quick-start.md): Install ciderpress and create your first documentation site in minutes.
- [Guides](https://ciderpress.dev/guides.md): Step-by-step instructions for deploying and configuring your site.
- [Deploy to GitHub Pages](https://ciderpress.dev/guides/deploying-to-github-pages.md): Build and deploy your ciderpress site to GitHub Pages with GitHub Actions.
- [Using portless.sh](https://ciderpress.dev/guides/using-portless.md): Run ciderpress dev behind portless.sh for stable HTTPS hostnames instead of localhost:6174.
- [Packages](https://ciderpress.dev/packages.md)
- [ciderpress](https://ciderpress.dev/packages/ciderpress.md): Press your docs. A documentation framework for monorepos, built on Rspress.
- [ciderpress](https://ciderpress.dev/packages/ciderpress/changelog.md)
- [@ciderpress/cli](https://ciderpress.dev/packages/cli.md): The ciderpress CLI — sync, dev, build, and serve commands. Part of ciderpress, the docs framework for monorepos.
- [@ciderpress/cli](https://ciderpress.dev/packages/cli/changelog.md)
- [@ciderpress/config](https://ciderpress.dev/packages/config.md): Config loading, Zod validation, and JSON schema generation. Part of ciderpress, the docs framework for monorepos.
- [@ciderpress/config](https://ciderpress.dev/packages/config/changelog.md)
- [@ciderpress/templates](https://ciderpress.dev/packages/templates.md): Liquid template registry for scaffolding docs. Part of ciderpress, the docs framework for monorepos.
- [@ciderpress/theme](https://ciderpress.dev/packages/theme.md): Theme types, tokens, and built-in themes (mulled, honeycrisp, grannysmith, amber, midnight, arcade). Part of ciderpress, the docs framework for monorepos.
- [@ciderpress/theme](https://ciderpress.dev/packages/theme/changelog.md)
- [@ciderpress/ui](https://ciderpress.dev/packages/ui.md): Rspress plugin, theme components, and styles. Part of ciderpress, the docs framework for monorepos.
- [@ciderpress/ui](https://ciderpress.dev/packages/ui/changelog.md)
- [Add a new pet to the store](https://ciderpress.dev/petstore/add-pet.md)
- [Create user](https://ciderpress.dev/petstore/create-user.md)
- [Creates list of users with given input array](https://ciderpress.dev/petstore/create-users-with-array-input.md)
- [Creates list of users with given input array](https://ciderpress.dev/petstore/create-users-with-list-input.md)
- [Delete purchase order by ID](https://ciderpress.dev/petstore/delete-order.md)
- [Deletes a pet](https://ciderpress.dev/petstore/delete-pet.md)
- [Delete user](https://ciderpress.dev/petstore/delete-user.md)
- [Finds Pets by status](https://ciderpress.dev/petstore/find-pets-by-status.md)
- [Finds Pets by tags](https://ciderpress.dev/petstore/find-pets-by-tags.md)
- [Returns pet inventories by status](https://ciderpress.dev/petstore/get-inventory.md)
- [Find purchase order by ID](https://ciderpress.dev/petstore/get-order-by-id.md)
- [Find pet by ID](https://ciderpress.dev/petstore/get-pet-by-id.md)
- [Get user by user name](https://ciderpress.dev/petstore/get-user-by-name.md)
- [Petstore API](https://ciderpress.dev/petstore/index.md)
- [Logs user into the system](https://ciderpress.dev/petstore/login-user.md)
- [Logs out current logged in user session](https://ciderpress.dev/petstore/logout-user.md)
- [Place an order for a pet](https://ciderpress.dev/petstore/place-order.md)
- [Updates a pet in the store with form data](https://ciderpress.dev/petstore/update-pet-with-form.md)
- [Update an existing pet](https://ciderpress.dev/petstore/update-pet.md)
- [Updated user](https://ciderpress.dev/petstore/update-user.md)
- [uploads an image](https://ciderpress.dev/petstore/upload-file.md)
- [Reference](https://ciderpress.dev/reference.md): Technical reference for every ciderpress API surface.
- [Badges & Statuses](https://ciderpress.dev/reference/badges.md): Label pages with badges like ALPHA or WIP — ad-hoc via `badge`, named via the `status` registry — rendered in the sidebar and breadcrumb.
- [Built-ins](https://ciderpress.dev/reference/built-ins.md): Components, diagrams, and markdown extensions included out of the box.
- [Accordion](https://ciderpress.dev/reference/built-ins/accordion.md): Expandable disclosure sections for progressive content reveal.
- [Badge](https://ciderpress.dev/reference/built-ins/badge.md): Inline labels with semantic variants and custom colors.
- [Browser Window](https://ciderpress.dev/reference/built-ins/browser-window.md): Wrap content in a fake browser chrome frame.
- [Cards](https://ciderpress.dev/reference/built-ins/cards.md): Card components for landing pages, feature grids, and workspace indexes.
- [Code Blocks](https://ciderpress.dev/reference/built-ins/code-blocks.md): Syntax highlighting, line numbers, diffs, and other code block features.
- [Color](https://ciderpress.dev/reference/built-ins/color.md): Color swatch display with click-to-copy.
- [Columns](https://ciderpress.dev/reference/built-ins/columns.md): Responsive grid layout for side-by-side content.
- [Desktop Window](https://ciderpress.dev/reference/built-ins/desktop-window.md): Base macOS-style window chrome that all window components build on.
- [Field](https://ciderpress.dev/reference/built-ins/field.md): Structured parameter and property documentation with type badges, status indicators, and nested grouping.
- [File Tree](https://ciderpress.dev/reference/built-ins/file-tree.md): Render interactive file tree visualizations.
- [Frame](https://ciderpress.dev/reference/built-ins/frame.md): Media wrapper for images and videos with captions.
- [IDE Window](https://ciderpress.dev/reference/built-ins/ide-window.md): Wrap code blocks in an editor-style window with file tabs.
- [Link Badges](https://ciderpress.dev/reference/built-ins/link-badges.md): Render canonical service URLs as compact, provider-branded links without authentication.
- [Math (KaTeX)](https://ciderpress.dev/reference/built-ins/math.md): Render LaTeX math expressions inline and in blocks.
- [Mermaid Diagrams](https://ciderpress.dev/reference/built-ins/mermaid.md): Render diagrams from text using Mermaid fenced code blocks.
- [Prompt](https://ciderpress.dev/reference/built-ins/prompt.md): AI prompt blocks with action buttons and expandable code view.
- [Steps](https://ciderpress.dev/reference/built-ins/steps.md): Vertical timeline stepper with numbered circles and connecting lines.
- [Superscript & Subscript](https://ciderpress.dev/reference/built-ins/superscript-subscript.md): Inline superscript and subscript syntax.
- [Terminal Window](https://ciderpress.dev/reference/built-ins/terminal-window.md): Render terminal sessions with commands, outputs, and colored text.
- [Tooltip](https://ciderpress.dev/reference/built-ins/tooltip.md): Hover-to-reveal definitions for inline contextual help.
- [CLI Commands](https://ciderpress.dev/reference/cli.md): Reference for all ciderpress CLI commands, flags, and behavior.
- [Frontmatter Fields](https://ciderpress.dev/reference/frontmatter.md): Complete reference for all frontmatter fields supported by ciderpress pages.
- [Icons](https://ciderpress.dev/reference/icons.md): Supported icon sets and color options.
- [Icon Colors](https://ciderpress.dev/reference/icons/colors.md): Available icon color classes for workspace and feature cards.
- [Icons](https://ciderpress.dev/reference/icons/overview.md): Supported icon sets and how to use them across your site.
- [Markdown Syntax](https://ciderpress.dev/reference/markdown.md): Every core CommonMark and GFM element ciderpress renders, shown live.
- [OpenAPI](https://ciderpress.dev/reference/openapi.md): Generate interactive API reference pages from an OpenAPI spec.
- [Tags](https://ciderpress.dev/reference/technology.md): Technology tag definitions for workspace cards.
- [Databases](https://ciderpress.dev/reference/technology/databases.md): Technology tags for databases and data tools.
- [Frameworks](https://ciderpress.dev/reference/technology/frameworks.md): Technology tags for frontend, backend, and mobile frameworks.
- [Infrastructure](https://ciderpress.dev/reference/technology/infrastructure.md): Technology tags for cloud providers, hosting, CI/CD, DevOps, monitoring, message queues, and infrastructure.
- [Integrations](https://ciderpress.dev/reference/technology/integrations.md): Technology tags for auth, AI/ML, CMS, and project-specific tools.
- [Languages](https://ciderpress.dev/reference/technology/languages.md): Technology tags for programming languages.
- [Technology Tags](https://ciderpress.dev/reference/technology/overview.md): How technology tags map to icons on workspace cards.
- [Tooling](https://ciderpress.dev/reference/technology/tooling.md): Technology tags for build tools, styling, and testing.
- [VSCode Extension](https://ciderpress.dev/reference/vscode-extension.md): Preview your ciderpress docs site directly inside VS Code.