使用指南

编辑信息

若要自行添加信息,需先 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 中所需字段为:

name: 欧雷 # 人物在网上的名称
brief: 多面玩家 # 用来与人物名称以「{name}:{brief}」的形式拼成个性化的网页标题,可选
description: 思考并探索改变生活、玩转人生的方法。 # 一句话简介,显示在人物页头部和人物卡片上的简短介绍
professions: # 人物职业,为了显示的完整性,建议不超过三个且总字数不超过十个字
  - title: 世界公民
    always: false # 显示尺寸较小时隐藏
  - title: 反混沌工程师
websites: # 个人网站,第一个将作为主站对待,可选
  - title: 欧雷流 # 网站标题
    url: https://ourai.ws/ # 网址
    description: 不走寻常路 # 网站简介,可选
    feed: https://ourai.ws/atom.xml # 用来动态获取最新发布的内容显示在人物页,可选
contacts: # 联系方式,可选,详见下面表格
  github: ourai
location: 浙江杭州 # 所在地
banner: # 人物页头图/人物卡片背景图的额外信息,可选
  description: Anti-chaos # 图片是什么

其中,联系方式可以为:

联系方式
电子邮箱 email 电子邮箱地址
手机或座机电话 phone 手机或座机号码,座机要带区号
微信 wechat 能搜到微信联系人的方式
Telegram telegram 能搜到 Telegram 联系人的方式
任何 SNS 网站 - 在 SNS 网站上的个人资料页唯一标识