使用指南
编辑信息
若要自行添加信息,需先 fork 仓库 https://github.com/linxoid/people
,再在 data
文件夹下创建自己的「persona」,最后发起 pull request 合并进去。
「persona」所在文件夹的名字就是 linxoid.com
上生成的人物信息页 URL https://linxoid.com/{slug}/
中的 slug
。
命名限制
对 slug
的命名有些要求:
- 可使用小写英文字母、阿拉伯数字、下划线(
_
)和连字符(-
),只能英文字母开头,最少 5 个字符; - 命名请用与个人品牌强相关的名词,不能与已存在
slug
同名,不能与已保留关键字相同,并尽可能避免已存在名人、组织及一些专有词汇。
请认真思考并命名,毕竟这是个人品牌的重要标识。若 slug
不符合以上要求,审核不予通过,还请谅解。
文件规范
文件夹下所应有的文件包括:
- 命名为
avatar
的图片文件,作为头像使用,格式不限,正方形,分辨率不超过500 * 500
; - 命名为
banner
的图片文件,作为人物页头图和人物卡片背景图使用,格式不限,横向长方形,建议宽度1000px
以上; - 描述人物信息的
metadata.yml
,具体内容见下方; - 对人物进行详细介绍的
readme.md
,可选。
人物元数据 metadata.yml
中所需字段为:
其中,联系方式可以为:
联系方式 | 键 | 值 |
---|---|---|
电子邮箱 | email | 电子邮箱地址 |
手机或座机电话 | phone | 手机或座机号码,座机要带区号 |
微信 | wechat | 能搜到微信联系人的方式 |
Telegram | telegram | 能搜到 Telegram 联系人的方式 |
任何 SNS 网站 | - | 在 SNS 网站上的个人资料页唯一标识 |