这个项目能做什么

Ciderpress 是专为 monorepo 设计的文档框架,只需极少配置即可将 markdown 文件转换为完整的文档站点。 主要能力: - 结构适配:顺应现有的仓库布局,而不是强加僵化的结构。 - 统一配置:侧边栏、导航、页脚、编辑链接、版本显示、公告和主题化均由单个配置文件控制。 - 内置主题:提供四个主题——honeycrisp、grannysmith、midnight 和 arcade,每个都完整支持深色模式。同时支持自定义主题。 - Monorepo 支持:包含工作区卡片、OpenAPI 集成和 Liquid 模板支持,面向内部开发者文档。 使用时需要通过 npm 安装,并定义一个配置文件(ciderpress.config.ts),通过标题、路径和 markdown 包含模式声明各个分区。该工具提供三个命令:`npx ciderpress dev` 用于启动带热重载的开发服务器,`npx ciderpress build` 用于生成生产构建,`npx ciderpress serve` 用于在本地预览构建后的站点。 采用 MIT 许可。