Get started →

    ciderpress

    Press your docs. A documentation framework for monorepos, built on Rspress.

    CI npm version License

    Features

    • Your docs, your structure — conforms to your repo, not the other way around.
    • One config, full chrome — sidebars, nav, footer, edit links, version chip, announcement, and theme from one file.
    • Beautiful themes out of the box — four built-in themes (honeycrisp, grannysmith, midnight, arcade) with full dark-mode support, plus first-class custom themes.
    • Monorepo-first — built for internal docs with workspace cards, OpenAPI integration, and Liquid template support.

    Install

    npm install ciderpress

    Usage

    Define your docs

    // ciderpress.config.ts
import { defineConfig } from 'ciderpress'

export default defineConfig({
  title: 'my-project',
  description: 'Documentation for my-project',
  sections: [
    {
      title: 'Getting Started',
      path: '/getting-started',
      include: 'docs/getting-started/*.md',
    },
    {
      title: 'Guides',
      path: '/guides',
      include: 'docs/guides/*.md',
      icon: 'pixelarticons:book-open',
      sort: 'alpha',
    },
  ],
  theme: { name: 'midnight' },
  site: {
    version: 'v1.0',
    edit: { repo: 'acme/docs', branch: 'main', directory: 'docs' },
    report: { repo: 'acme/docs' },
    topbarCta: { text: 'Get started →', href: '/getting-started' },
  },
})

    Run it

    npx ciderpress dev       # start dev server with hot reload
npx ciderpress build     # build for production
npx ciderpress serve     # preview production build

    Packages

    PackageDescription
    @ciderpress/cliCLI commands, watcher, dev TUI
    @ciderpress/configConfig loading + Zod schemas
    @ciderpress/uiRspress plugin, theme, and styles
    @ciderpress/themeTheme factory, tokens, and built-ins
    @ciderpress/templatesLiquid template registry

    License

    MIT