Skip to content

thebytefarm/ciderpress

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

162 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ciderpress

Press your docs.

A documentation framework for monorepos. Point it at your existing markdown — get a full site.

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: 'Internal developer docs',
  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

License

MIT

About

Opinionated docs framework for monorepos. Zero-config defaults - just point it at your existing markdown.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors