技术文档：Square 开源门户使用与安装指南

本文档将为您提供详细的安装和使用Square开源门户的方法，以及如何使用项目的API。以下是您需要了解的内容：

1. 安装指南

首先，确保您的环境中安装了以下依赖：

• Ruby（用于运行Jekyll）
• Python（用于生成项目数据）

接下来，按照以下步骤进行安装：

安装Ruby和Jekyll

1. 安装Ruby和bundler：

   gem install bundler # 第一次运行时
   

2. 安装项目依赖：

   bundle install # 第一次运行时
   

安装Python和生成工具

1. 安装Python依赖：

   pip install pystache requests pygithub3 # 第一次运行时
   

2. 更新项目数据：

   ./generate.py
   

2. 项目的使用说明

本地运行站点

要本地运行项目，请执行以下命令：

bundle exec jekyll serve

执行此命令后，项目将在本地服务器上运行，通常可通过http://127.0.0.1:4000/访问。

更新仓库列表

若要更新index.html页面上的仓库列表，请执行以下命令：

./generate.py

此脚本会读取repos.json文件中的仓库数据，并使用index.mustache作为模板更新index.html页面。

3. 项目API使用文档

本项目使用GitHub API获取仓库数据。默认情况下，脚本执行未经验证的请求，但GitHub限制了每小时60次未经验证的请求。若要使用认证请求绕过限制，请将GitHub API的认证信息添加到您的~/.netrc文件中，并使用个人访问令牌。

以下是配置netrc文件的示例：

machine api.github.com
  login YourUsername
  password PersonalAccessToken

请确保使用正确的用户名和个人访问令牌。

4. 项目安装方式

Square开源门户的安装方式如上所述，主要包括以下步骤：

1. 安装Ruby和Jekyll
2. 安装Python依赖
3. 运行generate.py生成项目数据
4. 使用Jekyll本地服务器运行项目

通过遵循这些步骤，您可以成功安装并运行Square开源门户。

---

请注意，本文档内容仅用于帮助用户更好地了解和使用Square开源门户项目。如需更多信息，请参考项目的官方文档和GitHub仓库。