Skip to content

Commit 88c4a03

Browse files
authored
Page structure adjustment (#58)
* fix: 详情页,移动端隐藏勋章logo * feat: 新增合作社区,详情页logo替换 * fix: rename logo-award * fix: conflict * feat: 合作社区增加 * fix: 更新2024 用户榜单信息 * fix: 增加更新用户详情脚本 * fix: 增加更新 osgraph 模板 * fix: 更新 2024 rankingList 数据 * fix: 更新 2024 user 数据 * fix: 晚上生成用户详情页脚本细节 * fix: 用户详情缺失,通过基本生成默认用户页面 * fix: 更新 rankingList * fix: 更新缺失往年用户数据 * fix: 补充脚本说明 * fix: 增加往年榜当页面,首页只保留最新一年的榜单数据 * fix: 完善文档 * fix: 恢复 ranking 模板 * fix: 更新首页数据与 2024-8 * fix: 详情页调整 * fix: 批量;批量更新2024详情页 * fix: 往年榜单详情模板调整,首页榜单只保留联合发起方 * docs: update readme * docs: rename file * docs: add description * update: an-lee metadata update
1 parent 26bae8c commit 88c4a03

File tree

252 files changed

+7001
-1671
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

252 files changed

+7001
-1671
lines changed

DEVELOP.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
### 项目开发
2+
3+
### 如何更新用户 github 信息?
4+
仓库 `script` 目录下存放了三个脚本
5+
- sync_xlab.js 从 xlab 接口 根据年份来同步 `rankingList.json` 中的最新排行信息,同步完成后需要 使用 update_year_user 来重新获取 github 用户信息。
6+
- update_year_user.js 根据年份来更新 `rankingList.json` 里面的用户的 github 信息,注意需要配置 github token 否则会被 github api 限制拉取频率导致更新失败, 然后修改 main 函数里面的需要更新的年份的信息即可。
7+
- update_all_user.js 更新整个 `rankingList.json` 中所有用户信息, 同样需要配置 github token 否则会被 github api 限制拉取频率导致更新失败。
8+
- front-matter.js, 在使用上面的脚本更新完用户信息后,使用此脚本来讲信息同步到 `source` 目录下对应的文件下的 `index.md` 的 front-matter 中 (--- front-matter ---)
9+
10+
`rankingList.json` 文件下数据更新前的机构
11+
12+
```json
13+
[
14+
{
15+
"year": 1999,
16+
"annualRanking": [
17+
{
18+
"ranking": 1,
19+
"login": "aaa",
20+
},
21+
{
22+
"ranking": 2,
23+
"login": "bbb",
24+
}
25+
]
26+
}
27+
...其它年份
28+
]
29+
```
30+
31+
脚本更新后的数据结构
32+
```json
33+
[
34+
{
35+
"year": 1999,
36+
"annualRanking": [
37+
{
38+
"ranking": 1,
39+
"login": "aaa",
40+
"github_id": 278432,
41+
"github_avatar": "https://avatars.githubusercontent.com/u/1111?v=4",
42+
"location": "上海,中国",
43+
"github_name": "a name"
44+
},
45+
{
46+
"ranking": 2,
47+
"login": "bbb",
48+
"github_id": 2222,
49+
"github_avatar": "https://avatars.githubusercontent.com/u/2222?v=4",
50+
"location": "上海,中国",
51+
"github_name": "b name"
52+
}
53+
]
54+
}
55+
...其它年份
56+
]
57+
```
58+
59+
### 往年榜单
60+
61+
所有往年榜单都在 `source/opensource-ranking` 目录下,每个文件都是一个年度榜单,文件名为 `2022.md` 这样的格式, 只需要修改里面的年份即可。
62+
例如
63+
```md
64+
---
65+
title: 榜单详情 2022
66+
permalink: /ranking-2022
67+
data_year: 2022
68+
---
69+
70+
```
71+
72+
首页只会展示最新一年的榜单数据。

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@
2222
cd OpenSourceWin
2323
npm i
2424
```
25+
如果用户名目录已经存在,你只需要去目录下面的 `index.md` 完善更新自己的信息即可。
2526

26-
然后你就可以创建自己的个人介绍页了**注意:页面的名称请使用你的 GitHub 用户名。**
27+
不存在你就需要创建自己的个人介绍页了**注意:页面的名称请使用你的 GitHub 用户名。**
2728

2829
```bash
2930
npx hexo new page <你的用户名>
@@ -36,16 +37,19 @@ npx hexo new page <你的用户名>
3637
slug: <GitHub用户名>
3738
name: <昵称,如果不填写则默认使用 slug>
3839
description: <在首页显示的个人简介,不要超过50个字>
39-
github_id: <GitHub ID,这是一个纯数字ID,用于自动获取头像,如果你想单独上传一个头像请提供下方的 avatar 字段>
40-
avatar: <个人头像文件,下面会介绍>
40+
avatar: <个人头像文件,下面会介绍, 优先级比 github_avatar 高>
41+
github_id: <GitHub ID,这是一个纯数字ID,用于展示嵌入 osgraph 的能力图谱>
42+
github_avatar: <Github 头像地址>
4143
---
4244

4345
<在这里可以用Markdown书写个人简介>
4446
```
4547

4648
上面提到的个人头像文件,我们建议每个用户都要提交一个个人头像,以便我们标示你。这个图片可以是 `jpg,png,gif` 格式,应该是一个正方形分辨率至少超过 `256x256` 的文件。
4749

48-
将此文件放置在个人简介的同级目录下,比如这个文件叫 `avatar.png`,它应该放置到 `source/foo` 目录下,然后上列的 `avatar` 项目应该填写 `avatar.png`
50+
将此文件放置在个人简介的同级目录下,比如这个文件叫 `avatar.png`,它应该放置到 `source/foo` 目录下,然后上列的 `avatar` 项目应该填写 `avatar.png`,如果改头像存在会优先展示该头像,不存在会降级使用 github_avatar 的值。
51+
52+
如果头像不存在,我们会通过脚本从 GitHub 上获取头像也就是上面的 github_avatar 的值。
4953

5054
所有内容修改完成后,将其提交至 GitHub,并向我们的主项目提交一个 PR 请求,然后等待我们的审核合并后即可正常显示。
5155

@@ -57,6 +61,12 @@ avatar: <个人头像文件,下面会介绍>
5761

5862
## 榜单列表
5963

60-
以下是每年入选此榜单的九十九位用户列表
64+
以下是当年入选此榜单的九十九位用户列表
6165

6266
[OpenSource.win](https://opensource.win/#detail)
67+
68+
其他年份的榜单请从导航栏`往年榜单`下拉菜单选择年份查看。
69+
70+
### 脚本批量更新用户信息
71+
72+
[脚本用法说明](./DEVELOP.md)

0 commit comments

Comments
 (0)