Page structure adjustment

DEVELOP.md

@@ -0,0 +1,72 @@
+### 项目开发
+
+### 如何更新用户 github 信息？
+仓库 `script` 目录下存放了三个脚本
+- sync_xlab.js 从 xlab 接口 根据年份来同步 `rankingList.json` 中的最新排行信息，同步完成后需要 使用 update_year_user 来重新获取 github 用户信息。
+- update_year_user.js 根据年份来更新 `rankingList.json` 里面的用户的 github 信息，注意需要配置 github token 否则会被 github api 限制拉取频率导致更新失败, 然后修改 main 函数里面的需要更新的年份的信息即可。
+- update_all_user.js 更新整个 `rankingList.json` 中所有用户信息, 同样需要配置 github token 否则会被 github api 限制拉取频率导致更新失败。
+- front-matter.js, 在使用上面的脚本更新完用户信息后，使用此脚本来讲信息同步到 `source` 目录下对应的文件下的 `index.md` 的 front-matter 中 （--- front-matter ---）
+
+`rankingList.json` 文件下数据更新前的机构
+
+```json
+[
+  {
+    "year": 1999,
+    "annualRanking": [
+      {
+        "ranking": 1,
+        "login": "aaa",
+      },
+      {
+        "ranking": 2,
+        "login": "bbb",
+      }
+    ]
+  }
+  ...其它年份
+]
+```
+
+脚本更新后的数据结构
+```json
+[
+  {
+    "year": 1999,
+    "annualRanking": [
+      {
+        "ranking": 1,
+        "login": "aaa",
+        "github_id": 278432,
+        "github_avatar": "https://avatars.githubusercontent.com/u/1111?v=4",
+        "location": "上海，中国",
+        "github_name": "a name"
+      },
+      {
+        "ranking": 2,
+        "login": "bbb",
+        "github_id": 2222,
+        "github_avatar": "https://avatars.githubusercontent.com/u/2222?v=4",
+        "location": "上海，中国",
+        "github_name": "b name"
+      }
+    ]
+  }
+   ...其它年份
+]
+```
+
+### 往年榜单
+
+所有往年榜单都在 `source/opensource-ranking` 目录下，每个文件都是一个年度榜单，文件名为 `2022.md` 这样的格式, 只需要修改里面的年份即可。
+例如
+```md
+---
+title: 榜单详情 2022
+permalink: /ranking-2022
+data_year: 2022
+---
+
+```
+
+首页只会展示最新一年的榜单数据。

README.md

@@ -22,8 +22,9 @@
 cd OpenSourceWin
 npm i
 ```
+如果用户名目录已经存在，你只需要去目录下面的 `index.md` 完善更新自己的信息即可。
 
-然后你就可以创建自己的个人介绍页了，**注意：页面的名称请使用你的 GitHub 用户名。**
+不存在你就需要创建自己的个人介绍页了，**注意：页面的名称请使用你的 GitHub 用户名。**
 
 ```bash
 npx hexo new page <你的用户名>
@@ -36,16 +37,19 @@ npx hexo new page <你的用户名>
 slug: <GitHub用户名>
 name: <昵称，如果不填写则默认使用 slug>
 description: <在首页显示的个人简介，不要超过50个字>
-github_id: <GitHub ID，这是一个纯数字ID，用于自动获取头像，如果你想单独上传一个头像请提供下方的 avatar 字段>
-avatar: <个人头像文件，下面会介绍>
+avatar: <个人头像文件，下面会介绍, 优先级比 github_avatar 高>
+github_id: <GitHub ID，这是一个纯数字ID，用于展示嵌入 osgraph 的能力图谱>
+github_avatar: <Github 头像地址>
 ---
 
 <在这里可以用Markdown书写个人简介>
 ```
 
 上面提到的个人头像文件，我们建议每个用户都要提交一个个人头像，以便我们标示你。这个图片可以是 `jpg,png,gif` 格式，应该是一个正方形分辨率至少超过 `256x256` 的文件。
 
-将此文件放置在个人简介的同级目录下，比如这个文件叫 `avatar.png`，它应该放置到 `source/foo` 目录下，然后上列的 `avatar` 项目应该填写 `avatar.png`。
+将此文件放置在个人简介的同级目录下，比如这个文件叫 `avatar.png`，它应该放置到 `source/foo` 目录下，然后上列的 `avatar` 项目应该填写 `avatar.png`，如果改头像存在会优先展示该头像，不存在会降级使用 github_avatar 的值。
+
+如果头像不存在，我们会通过脚本从 GitHub 上获取头像也就是上面的 github_avatar 的值。
 
 所有内容修改完成后，将其提交至 GitHub，并向我们的主项目提交一个 PR 请求，然后等待我们的审核合并后即可正常显示。
 
@@ -57,6 +61,12 @@ avatar: <个人头像文件，下面会介绍>
 
 ## 榜单列表
 
-以下是每年入选此榜单的九十九位用户列表。
+以下是当年入选此榜单的九十九位用户列表。
 
 [OpenSource.win](https://opensource.win/#detail)
+
+其他年份的榜单请从导航栏`往年榜单`下拉菜单选择年份查看。
+
+### 脚本批量更新用户信息
+
+[脚本用法说明](./DEVELOP.md)