About this project
Ciderpress is a documentation framework designed for monorepos that converts markdown files into a complete documentation site with minimal configuration.
Key capabilities:
- Structure conformity: adapts to your existing repository layout rather than imposing a rigid structure.
- Unified configuration: sidebars, navigation, footer, edit links, version display, announcements, and theming are controlled from a single config file.
- Built-in themes: ships with four themes—honeycrisp, grannysmith, midnight, and arcade—each with full dark-mode support. Custom themes are also supported.
- Monorepo support: includes workspace cards, OpenAPI integration, and Liquid template support, targeting internal developer documentation.
Usage requires installing via npm and defining a config file (ciderpress.config.ts) that declares sections with title, path, and markdown include patterns. The tool provides three commands: `npx ciderpress dev` to start a development server with hot reload, `npx ciderpress build` to generate a production build, and `npx ciderpress serve` to preview the built site locally.
Licensed under MIT.
Comments
0 people shared their preference · Deer Point appears after 10 participants
Sign in to join the discussion.