Shopify 开源项目技术文档

一、安装指南

1. 克隆项目分支或下载 ZIP，然后在终端中导航到该文件夹。
2. 安装 Jekyll：gem install jekyll
3. 安装 Sass：gem install sass，使用 sass -v 确认安装成功。
4. 安装 Compass：gem install compass
5. 确保所有依赖都已设置好，运行 bundle install
6. 运行 bundle exec jekyll serve 编译 Jekyll 和 Sass 文件为静态资源到 _site 文件夹。
7. 在另一个终端窗口中，运行 compass watch 以监控文件更改。
8. 在浏览器中访问 http://localhost:4000 查看页面。

二、项目的使用说明

• 本地构建时，每次保存文件，bundle exec jekyll serve 会编译 Jekyll 和 Sass 文件到 _site 文件夹。
• compass watch 会更新 ie.css 和 main.css。
• 使用 rake build 手动解析 SCSS 文件。
• 本地构建的内容将几乎是空的，因为：
  • 页面使用 Jekyll 的 site.github.public_repositories 对象获取仓库数据，这个数据仅在实时环境中可用。
  • 自定义仓库数据由 GitHub 的 JS API 生成，因此将在本地显示。

三、项目API使用文档

项目使用的数据来自 Jekyll，所有更改都会触发重新构建和更新数据。若要包含一个仓库到列表中，需要在 javascripts/custom-repos.js 中添加到 optInRepos 数组中，该仓库必须属于 Shopify。若要包含非 Shopify 仓库，请使用 customRepos。在同一文件中设置项目语言或自定义头像。

四、项目安装方式

请按照以下步骤进行安装：

1. 克隆项目分支或下载 ZIP，然后在终端中导航到该文件夹。
2. 安装 Jekyll、Sass 和 Compass。
3. 运行 bundle install 设置所有依赖。
4. 运行 bundle exec jekyll serve 和 compass watch。
5. 在浏览器中访问 http://localhost:4000 查看页面。