mirror of
https://github.com/one-among-us/data.git
synced 2024-11-26 04:57:38 +08:00
73 lines
2.8 KiB
Markdown
73 lines
2.8 KiB
Markdown
# Our Data
|
||
|
||
这里存了 [One Among Us](https://one-among.us/) 的条目，欢迎贡献！
|
||
|
||
在贡献之前请阅读我们的 [文档和贡献指南](https://github.com/one-among-us/how-we-work/blob/main/README-zh_Hans.md)。
|
||
|
||
Please read our [How-We-Work](https://github.com/one-among-us/how-we-work/blob/main/README.md) before contributing.
|
||
|
||
## 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) - 献花和编辑后端源码
|
||
|
||
## File Structure
|
||
|
||
* 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` 就可以更新繁体了!
|
||
|
||
这个脚本不会覆盖在已有的繁体文件上的更改，更新已经生成过繁体的简体文稿之后会自动合并，不过还是要手动检查一下哦。
|
||
-->
|
||
|
||
## HData
|
||
|
||
`/data/hdata.json` defined some data which used for entry properties. Here is some description of it:
|
||
|
||
* `commentOnly`: `string[]`, the entries which include comments only, like `tdor` or `tdov`
|
||
* `exclude`: `string[]`, the directories which would not be handled
|
||
* `notShowOnHome`: `string[]`, if you don't want a entry show on the home, add it into this item
|
||
* `actualHide`: `string[]`, if you don't want a entry show on the home and won't be redirected by random buttons, add it into this item.
|
||
If you set a entry in this list, you have no need to set it into `notShowOnHome` again.
|
||
|
||
### Example
|
||
|
||
```json
|
||
{
|
||
"commentOnly": [
|
||
"tdor"
|
||
],
|
||
"exclude": [
|
||
"tdov"
|
||
],
|
||
"notShowOnHome": [
|
||
"Anilovr",
|
||
"noname3031"
|
||
],
|
||
"actualHide": [
|
||
"ArtsEpiphany"
|
||
]
|
||
}
|
||
```
|
||
|
||
If you don’t understand how to modify it, please feel free to [Contact Us](https://one-among.us/about/).
|