scaling-book

环境要求

• Ruby 3.4.5 或以上版本，并确保正确版本在 PATH 中
• ImageMagick

安装与启动步骤

1. 1安装系统依赖

   在 macOS 上使用 Homebrew 一次性安装 ImageMagick 和 Ruby；其他系统需先用系统包管理器准备好这两项。

   brew install imagemagick ruby

   复制

2. 2安装 Jupyter

   README 要求本机已安装 Jupyter，用 pip 安装即可，供仓库中相关文档内容使用。

   pip install jupyter

   复制

3. 3确认 Ruby 版本

   检查当前使用的 Ruby 版本是否至少为 3.4.5；如果版本不符，需调整 PATH，指向新版 Ruby。

   ruby -v

   复制

4. 4克隆仓库

   把 scaling-book 仓库拉到本地，后续的构建和启动都在这个目录里进行。

   git clone https://github.com/jax-ml/scaling-book.git

   复制

5. 5安装 Ruby 依赖

   进入仓库目录后，用 Bundler 按项目记录安装构建网站所需依赖。

   cd scaling-book
   bundle install

   复制

6. 6启动本地站点

   运行 Jekyll 本地服务开始构建，保持终端窗口不要关闭。

   bundle exec jekyll serve

   复制

7. 7访问本地页面

   服务启动成功后，在浏览器打开本地地址即可阅读整本书。

如何确认成功

执行 jekyll serve 无报错后，浏览器打开 http://127.0.0.1:4000/scaling-book 能看到书的首页，说明构建成功。

常见问题

注意事项

• README 明确本地访问路径包含 /scaling-book，不要只访问根路径。
• 仓库主分支有新提交时，由 GitHub Action 自动部署到 GitHub Pages，本地仅用于预览。
• 安装完成后先核对 ruby -v，版本不足会导致 bundle install 或构建失败。