one-among-us-data/README.md

31 lines
1.3 KiB
Markdown

# Our Data
这里存了 [one-among.us](https://one-among.us/) 的条目,欢迎贡献!
## GitHub Repo 结构
* [data](https://github.com/one-among-us/data) - 条目内容存储
* [web](https://github.com/one-among-us/web) - 网页前端源码
* [backend](https://github.com/one-among-us/backend) - 献花和编辑后端源码
## 文件结构
* Directory `/people/<userid>/`: Data for a specific person
* `info.json5`: Profile information
* `page.md`: Profile page content
* `photos`: Photo directory
* `comments`: List of comments made by other users in the format of `yyyy-mm-dd-{name}-{id}.txt`
* Branch `gh-pages`: Data that's automatically generated by Github Actions
* `people-list.json`: A list of all people currently in the repository
* Directory `/people/<userid>/`: Built data for a specific person
* `page.js`: `page.md` built with MDX
## 生成/更新繁体文稿
更新简体文稿之后请手动执行一个脚本生成繁体文稿。(因为 Github Actions 奇怪的问题太多了,还好难测试,还是换成本地构建啦)
构建环境需要安装 docker, 然后 `docker-compose up` 就可以更新繁体了!
这个脚本不会覆盖在已有的繁体文件上的更改,更新已经生成过繁体的简体文稿之后会自动合并,不过还是要手动检查一下哦。