指南 | 红岩博客

名人堂怎么加友链

Mon, 17 Aug 2026 00:28:33 +0800

名人堂页面展示的是和红岩互通的伙伴站点。数据集中放在 data/pages/links.yaml 这一个文件里，加友链只需要改它。

怎么加

打开 data/pages/links.yaml，在 links 列表里加一条：

- name: 站点名
 url: https://站点地址
 description: 一句话介绍（可选）
 image: https://站点/头像.png（可选）

字段说明

name：站点名，必填
url：站点地址，必填
description：一句话介绍，可选，会直接显示在卡片上
image：头像，可选

头像规则

填了 image：直接用它。支持填图片 URL，也支持本地文件（assets/media/ 下的路径，比如 friends/xxx.png）
没填：自动取 https://站点/favicon.ico
图标加载失败：回退成站名首字

注意：有的站点根路径并没有 favicon.ico（图标被放在了别处），这种情况自动抓取会失败，卡片显示首字占位。想让头像正常显示，就去站点页面的 HTML 里找 <link rel="icon" ...> 声明的地址，填到 image 字段即可。

提交

改完这一个文件后，按《贡献博客指引》提一个 Pull Request，合并后网站会自动重新部署，新友链就上线了。

PR 自动生成日志

Sun, 16 Aug 2026 19:09:52 +0800

修复日志和公告现在可以全自动记录了：不需要手动在 content/log/ 下新建文件，只要在 PR 上打个标签。

怎么用

发起 Pull Request
在 PR 上添加 log 标签
合并进 main 后，CI 会自动：
- 用 PR 标题生成日志标题
- 用 PR 描述的第一段生成日志摘要
- 在 content/log/pr-<编号>/ 下生成日志条目并推回仓库
- 重新部署站点

完成后就能在日志栏看到这条记录了。

注意事项

不想记录到日志栏的 PR 不要打 log 标签
PR 描述的第一段会被用作日志摘要，建议写清楚本次改动的要点
生成的日志条目会自动附带来源 PR 链接
也可以手动在 content/log/ 下写日志条目，必填 title / summary，date 会自动按首次提交时间填写

贡献博客指引

Sun, 16 Aug 2026 18:13:13 +0800

写一篇文章只需要一个 Markdown 文件，剩下的自动化和部署都交给 CI。

文章放在哪里

每篇文章是一个目录：

content/blog/<文章英文短名>/index.md

目录名建议用英文小写和短横线，比如 content/blog/contribution-guide/index.md。这样文章地址就是 /blog/contribution-guide/。

必填 front matter

文件开头必须用 --- 包裹一段 YAML，包含以下字段：

---
title: "文章标题"
summary: "一句话简介，会显示在博客卡片和分享描述里。"
tags:
 - 指南
authors:
 - 你的GitHub用户名
---

title：文章标题
summary：一句话简介
authors：你的 GitHub 用户名（不是昵称）
tags：可选，一个或多个标签
date：可选，不用写。CI 会自动按文章首次提交时间填写，并用于排序和显示

正文怎么写

正文用 Markdown，直接跟在 front matter 后面。建议：

标题从 ## 开始，# 留给页面大标题
代码块写清楚语言，比如 ```yaml
图片可以放在文章目录里，用相对路径引用，比如 ![配图](cover.png)

作者档案自动生成

如果 authors 里填的用户名还没有档案（data/authors/<用户名>.yaml），CI 会：

从 GitHub 抓取你的名字、简介和主页
自动创建 data/authors/<用户名>.yaml 和头像
已存在的档案不会被覆盖，你手动维护的内容始终保留

想自定义档案（职务、社交链接、个人简介），见《作者如何维护自己的档案》。

怎么提交

两种方式任选：

GitHub 网页直接写：在仓库里进入 content/blog/，点 “Add file” 新建目录和 index.md，写完在下方 “Commit changes” 里选择创建一个新分支，再点 “Compare & pull request” 发起 Pull Request。
本地提交：clone 仓库，新建分支写文章，提交推送到远程，然后在 GitHub 上发起 Pull Request。

PR 提交后 CI 会自动校验：缺少必填字段会报错并阻止合并。合并到 main 后网站自动重新部署，文章就上线了。

日志栏自动记录

如果这次改动希望自动记录到日志栏（修复日志、公告等），请在 PR 上打上 log 标签。PR 合并进 main 后，CI 会自动：

用 PR 标题生成日志标题
用 PR 描述的第一段生成日志摘要
生成 content/log/pr-<编号>/index.md 并推回仓库，站点随即重新部署

不需要记录到日志栏的 PR 不用打标签。

本地预览

在仓库根目录运行：

hugo server

然后打开 http://localhost:1313/ 即可预览。写完记得确认：

地址能正常访问
文章卡片上的标题、简介、作者显示正常
作者头像和档案链接正确

作者如何维护自己的档案

Sun, 16 Aug 2026 17:48:45 +0800

每个作者的简介页都由仓库里的一个 YAML 文件驱动：data/authors/<你的用户名>.yaml。维护它不需要懂代码，改完提个 PR 就行。

档案长什么样

name:
 display: mkaaad
role: 后端工程师
bio: 喜欢折腾各种技术。
links:
 - icon: brands/github
 url: https://github.com/mkaaad

可以维护哪些信息

name.display：页面显示的名字
role：职务 / 角色（会显示在作者页和文章卡片上）
bio：个人简介
links：社交链接列表，每项是 icon + url

链接图标怎么填

两种方式任选：

内置品牌图标：icon: brands/github。主题内置 3600+ 品牌图标，常用的 GitHub、B 站（brands/bilibili）、X（brands/x）、微信（brands/wechat）、知乎（brands/zhihu）、QQ（brands/qq）、邮箱（brands/gmail）都有。
直接填图片地址：icon: https://example.com/favicon.ico。任何以 http(s) 开头的图片地址都可以直接当图标用，适合没有内置图标的网站。

CI 会自动做什么

当一篇新文章引用了还没有档案的作者时，CI 会自动从 GitHub 抓取名字、简介和头像，创建 data/authors/<用户名>.yaml。
已存在的档案不会被覆盖——你手动维护的内容始终保留。
文章 front matter 必须包含 title、summary、authors（填 GitHub 用户名），date 可选，CI 会自动按首次提交时间写入，否则 PR 校验会报错。

怎么提交修改

打开仓库里的 data/authors/<你的用户名>.yaml。
点右上角铅笔图标进入编辑，改完在下方 “Commit changes” 里选择创建一个新分支。
发起 Pull Request，合并后网站自动重新部署，你的作者页就更新了。

显示位置

修改后以下位置都会同步更新：

作者详情页：/authors/<用户名>/
文章页左侧作者栏（大屏）
文章底部作者卡片（小屏）
博客卡片上的作者信息