一款无需构建过程、可将 Markdown 文件直接转为文档网站的工具。
3.2万5784JavaScriptMIT更新于 昨天
- Star
- 39,565
- Fork
- 2,655
- 未关闭 Issue
- 201
- 最近提交
- 昨天
这是什么？
DevDocs 将多种编程语言、框架和工具的参考文档整合到一个网页界面中，提供即时搜索、键盘快捷键、深色主题和适配移动端的布局。用户可以自行选择需要安装的文档集，只加载实际使用的内容。
应用完全在浏览器中运行，下载文档后可离线使用。后端由 Ruby 编写的抓取器负责从上游来源生成规范化的 HTML 和搜索索引，并配有一个基于 Sinatra 的小型服务器。项目支持 Docker 运行，也可以用 Ruby 手动安装，通过 thor 命令行工具完成文档的下载、生成和打包。
项目侧重 API 和参考类内容，而非教程指南，由 freeCodeCamp 运营。贡献者可以通过抓取器和过滤器机制添加新的文档集。
核心功能
- 01跨多个已安装文档集即时搜索。
- 02下载文档后可离线使用。
- 03支持完整的键盘导航和深色主题。
- 04可通过 Docker 或手动配置 Ruby 环境运行。
- 05提供 Thor 命令行工具，用于下载、生成和打包文档。
适用场景
- 在浏览器中快速查阅编程语言或框架的 API 参考。
- 在出差或网络不稳定时离线阅读文档。
- 使用 Docker 自托管一个私有文档浏览器。
- 为团队内部构建或维护自定义文档集。
快速上手
- 1
使用 Docker 在本地运行 DevDocs
docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest
使用前须知
- 项目目前正在寻找维护者，因此长期维护存在不确定性。
- 手动安装需要 Ruby 4.0.7、libcurl、bsdtar 和 JavaScript 运行时，并且文档集需要另外下载。
标签
常见问题
- devdocs 是什么？
- 一个将多种开发者 API 文档整合到一起、支持即时搜索和离线使用的网页文档浏览器。 DevDocs 将多种编程语言、框架和工具的参考文档整合到一个网页界面中，提供即时搜索、键盘快捷键、深色主题和适配移动端的布局。用户可以自行选择需要安装的文档集，只加载实际使用的内容。
- devdocs 可以免费使用吗？用的什么许可证？
- devdocs 以 MPL-2.0 许可证开源。用于商业产品前，请先确认许可证条款。
- devdocs 还在维护吗？
- 活跃维护中。devdocs 最近一次提交是在 2026年10月21日。
- devdocs 适合用来做什么？
- 在浏览器中快速查阅编程语言或框架的 API 参考。 在出差或网络不稳定时离线阅读文档。 使用 Docker 自托管一个私有文档浏览器。 为团队内部构建或维护自定义文档集。
- devdocs 怎么安装和运行？
- 使用 Docker 在本地运行 DevDocs: docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest
- 在哪里获取 devdocs？
- 源代码和安装说明在 GitHub 上：https://github.com/freeCodeCamp/devdocs
概要由 AI 根据项目 README 生成；GitHub 数据每日更新。
相关项目
基于 reStructuredText 的 Python 文档生成工具，可输出 HTML、PDF、EPUB 等多种格式。
80722610PythonOther更新于 6小时前
远程控制 Claude Code、Codex 等 AI 编程代理，在本机运行会话，通过手机或网页操作。
5269616TypeScriptAGPL-3.0更新于 前天
开源工具，可根据 OpenAPI、Swagger、AsyncAPI 或 GraphQL 定义生成响应式的 API 参考文档站点。
2.6万2404TypeScriptMIT更新于 昨天
基于 React.js 构建文档网站的框架，支持 Next.js、Astro 及多种 Vite 生态的 React 框架。
1.3万745TypeScriptMIT更新于 前天
Swagger UI 可根据 OpenAPI/Swagger 规范文件在浏览器中生成可交互的 API 文档。
2.9万9251JavaScriptApache-2.0更新于 前天