Files
SuBlog/docs/open-source-configuration.md
T

1.6 KiB

开源配置说明

目标

本项目将站点身份和可关联个人的信息从可提交代码中分离,避免公开仓库包含个人域名、社交账号、备案号、评论仓库标识、赞助记录及收款码。

配置边界

config/site.ts 是唯一的本地私有配置,已被 .gitignore 忽略。首次使用时复制 config/site.ts.example 创建该文件。

内容 保存位置 是否提交
站点名称、域名、头像、社交账号、友链 config/site.ts
项目反馈地址、Giscus 标识、备案号、赞助记录 config/site.ts
收款二维码 public/sponsors/qrcode/
可复用的字段结构与默认值 config/site.ts.example

siteConfig.giscussiteConfig.sponsors.qrcode.wechatsiteConfig.filing 留空时,评论区、收款入口和备案信息不会渲染。项目反馈链接也由 siteConfig.repository.issuesUrl 统一提供。

归档流程

  1. 复制并填写本地配置:cp config/site.ts.example config/site.ts
  2. 将收款二维码放入 public/sponsors/qrcode/,并在本地配置中填写资源路径。
  3. 执行 pnpm generate,确认未配置项不会显示且构建成功。
  4. 使用 git status --ignored 检查 config/site.ts 和收款码目录仍处于忽略状态。
  5. 提交前搜索个人域名、账号、备案号和二维码文件,确认没有被意外加入版本控制。

文章中的公开项目链接和技术引用属于内容资产,不会自动改写;如需匿名发布,请在提交前单独审阅 content/posts/