提交 Bug 报告
请通过 GitHub Issues 提交:- 浏览器和操作系统
- 复现步骤
- 预期 vs 实际行为
- 截图或控制台报错
功能建议
通过 Feature Request 告诉我们。贡献代码
开发环境
public/index.html 即可开始,无需安装依赖。架构、API 地图、D1 模型与发版流程见开发文档。涉及云端接口时改用:
提交前自测
修改前端源码后重新压缩
仓库的「零构建」指的是运行时不需要构建步骤,但public/ 下的 *.min.js / *.min.css 是提交进仓库的产物,改完源码需要手动重新生成:
重新生成 README 截图
screenshots/ 中的图片由可复现工具生成,不需要手工截图:
scripts/screenshots/ 三个文件组成:demo-content.mjs(示例文章 / 评论 / 音乐数据)、demo-server.mjs(本地 mock API 服务器)、capture.mjs(无头 Chrome 驱动)。前置条件是本机安装 Chrome 或 Edge,并可选安装 puppeteer-core(开发依赖,站点运行时不需要)。
版本与资源版本号
修改前端 JS / CSS 后运行node scripts/minify.mjs,并同步更新:
public/app.js的BLOG_VERSIONpublic/index.html的全部?v=public/sw.js的CACHE_VERSION
public/locales/*.json 后还要递增 public/i18n.js 的 I18N_VER。
PR 流程
- Fork 仓库
- 创建分支:
git checkout -b feature/your-feature - 提交:
git commit -m "feat: add xxx" - 推送:
git push origin feature/your-feature - 发起 Pull Request
Commit 规范
采用 Conventional Commits:文档中英双语约定
主仓库的文档全部中英双语,两种形态:
新增或修改文档时请同时更新两个文件(或同一文件的两段),并把新文档补进
docs/README.md 的「文档索引」表。
本站(
docs.2024921.xyz)是中文单语文档站;英文内容请写进主仓库的 *_EN.md,不要在本站新增英文页面。翻译贡献
界面翻译文件位于public/locales/<lang>.json(zh-CN / en / ja / ko / hi,每种语言键集完全一致),欢迎修正现有翻译或添加新语言。改动语言包后请同步递增 public/i18n.js 中的 I18N_VER,以强制浏览器拉取新文件。详见国际化。
文档改进
- 修正错别字或过时信息
- 添加教程或截图
- 本站页面统一使用中文、Mintlify MDX(frontmatter 仅
title与description),跨仓库链接请用 GitHub 绝对地址
