devdocs

环境要求

• Docker（官方推荐的运行方式）
• 手动安装需 Ruby 4.0.6（见 Gemfile）
• libcurl
• ExecJS 支持的 JavaScript 运行时（macOS/Windows 自带，Linux 需 Node.js）

安装与启动步骤

1. 1运行官方镜像

   一条命令即可启动 DevDocs，容器映射 9292 端口，镜像每月随最新文档自动更新。

   docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest

   复制

2. 2或自行构建镜像

   先克隆源码再本地构建镜像，然后以同样端口启动，适合想自行修改代码的场景。

   git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
   docker build -t devdocs .
   docker run --name devdocs -d -p 9292:9292 devdocs

   复制

3. 3准备系统依赖

   手动安装需 Ruby 4.0.6、libcurl 和 JS 运行时；Arch Linux 可用右侧命令一次装齐。

   pacman -S ruby ruby-bundler ruby-erb ruby-irb

   复制

4. 4安装 Ruby 依赖

   克隆仓库后安装 bundler 并执行 bundle install 拉取项目所需 gem。

   git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
   gem install bundler
   bundle install

   复制

5. 5下载文档数据

   从 DevDocs 服务器下载预生成的默认文档集；也可用 --all 下载全部、thor docs:list 查看列表。

   bundle exec thor docs:download --default

   复制

6. 6启动本地服务

   用 rackup 启动 Sinatra 应用，默认监听 9292 端口。

   bundle exec rackup

   复制

7. 7访问与快捷键

   浏览器打开 localhost:9292；按 / 或 Ctrl+K 聚焦搜索，按 ? 查看内置帮助。

关键配置

如何确认成功

浏览器打开 http://localhost:9292，页面正常显示文档列表即成功；首次请求需几秒编译资源，请稍等。

常见问题

注意事项

• 官方建议非贡献者优先使用托管版 devdocs.io，无需本地部署。
• Docker 镜像每月自动构建更新，包含最新文档。
• 更新代码只能用 git pull origin main，暂无其他升级机制。
• 容器以 -d 后台运行，名称为 devdocs，可用 docker 命令管理。