CODEDOC
软件描述
CODEDOC 是一个开源工具,可帮助您创建美观且现代化的软件文档。它能将您的 Markdown 文件转换为 JAMStack 应用,您可轻松将其部署到 GitHub Pages 等服务上。
官方网站
访问软件的官方网站了解更多信息
官方认证
codedoc.cc
安全链接HTTPS
什么是 CODEDOC?
CODEDOC 是一个开源工具,可帮助您创建美观且现代化的软件文档。它能将您的 Markdown 文件转换为 JAMStack 应用程序,轻松部署到 GitHub Pages 等服务。
自定义功能
可轻松更改文档的任意部分,包括主题颜色、字体、每页元数据及布局。使用基于 JSX/TSX 的组件创建自定义头部或目录,或在 Markdown 中使用自定义的 JSX/TSX 组件。
CODEDOC 的组件化结构意味着您可在不同项目中复用自定义组件,也可将其发布(例如至 NPM),让他人共享使用!
内置搜索
若您的项目托管在 GitHub 上,CODEDOC 默认通过 GitHub 搜索 API 提供跨文档搜索功能。您还可轻松集成自定义搜索 API 到默认搜索组件中,或直接使用自定义搜索组件。
内置暗黑模式
2020 年了,暗黑模式应被视为基本权利!CODEDOC 支持所有文档的暗黑模式。默认根据设备设置切换,同时允许读者手动覆盖。
协作友好
全部采用 Markdown 格式,您可借助 Git 等任何版本控制软件与团队成员轻松协作编写文档。无需依赖功能残缺的复杂可视化界面!
开源免费
CODEDOC 是一款完全免费的开源工具,采用 MIT 许可证,无任何附加条件。我最初只是需要这样一个工具,来为正在参与的一些开源项目撰写可用的文档。


