一句话CODEDOC 是一个 MIT 许可的开源文档生成工具,可将 Markdown 文档构建为适合 GitHub Pages 等部署的 JAMStack 文档站点。
定价免费开源 文本明确说明 completely free-to-use、MIT-licensed;未提及商业版、托管版或付费支持。
适合谁开源项目维护者、软件项目团队、需要用 Markdown 编写并发布现代化技术文档的开发者
核心功能Markdown 转 JAMStack/HTML 文档站点CLI 初始化、实时预览与构建增强 Markdown 组件语法增强代码片段展示主题、布局、Header/Footer 可定制GitHub Search API 跨文档搜索暗色模式基于 Git 的协作写作GitHub Pages 发布支持
功能与用途用于创建现代化软件文档。它从 Markdown 文件生成 JAMStack/静态 HTML 文档站点,支持本地 serve 实时预览、build 构建部署,并默认适配 GitHub Pages。面向代码教学与项目说明,提供目录、页级元信息、Header/Footer、暗色模式、搜索和代码片段增强等能力。
支持语言/框架文档源格式支持 CommonMark 与 GitHub Flavored Markdown,并通过 @connectv/marked 扩展 quoted components 与 linked components。自定义组件基于 Typescript 与 TSX/JSX,组件系统使用 CONNECTIVE SDH。代码高亮使用 Prism,支持 Prism 支持的语言;示例中出现 tsx、go、python、rust、bash、docker 等。
开源还是闭源开源。文本明确标注 MIT License,并说明 completely free-to-use、MIT-licensed、no strings attached。
自托管选项生成静态/JAMStack 应用,可自行部署到 GitHub Pages 等静态托管服务。构建产物为 HTML、bundle 和样式文件;文本未提及官方托管服务。
定价免费使用,MIT 许可。未提及付费计划、企业版或付费支持。
API/SDK提供 npm 安装的 CLI:@codedoc/cli,常用命令包括 codedoc init、codedoc serve、codedoc build。示例显示可从 @codedoc/core programmatically import build,并通过 @codedoc/core/components 使用组件。
集成与生态可与 GitHub 仓库、GitHub Pages、GitHub Search API、Git、NPM 生态结合;Header/Footer 示例中出现 GitHub Button、GitterToggle;自定义组件可跨项目复用或发布到 NPM。
文档质量抓取正文包含安装、使用、发布、Markdown 扩展、代码片段、配置、目录、Header/Footer 自定义等大量示例,结构较完整,代码示例丰富。但内容偏开发者导向,深入定制需要理解 TypeScript/TSX 与配置文件。
中国访问未知
适用场景为 GitHub 仓库生成项目文档;将 docs/md 中的 Markdown 构建为静态 HTML;发布到 GitHub Pages;制作带自定义组件、代码示例和暗色模式的技术文档站。
同类Docusaurus、VitePress、VuePress、MkDocs、Docsify