仓库指南

仓库指南

项目结构与模块组织

本仓库是一个由 Jekyll 驱动的 GitHub Pages 博客。已发布文章位于 _posts/,文件名遵循 YYYY-MM-DD-title.md 格式;未发布草稿放在 _drafts/,Wiki 内容放在 _wiki/。独立页面位于 pages/,可复用的 Liquid 模板分别存放在 _layouts/_includes/。站点数据使用 _data/*.yml,样式与脚本位于 assets/css/assets/js/,文章图片等媒体文件放在 images/。全局配置和插件设置集中在 _config.yml

构建、测试与本地开发

  • bundle install:安装 Gemfile 中声明的 Ruby 依赖。
  • bundle exec jekyll serve --livereload:启动本地服务,默认地址为 http://127.0.0.1:4000,并在文件变化时自动刷新。
  • bundle exec jekyll build:将生产站点生成到 _site/;提交变更前必须运行。
  • bundle exec jekyll doctor:检查常见的配置和 URL 问题。

_site/ 是生成的构建产物,不要提交到版本库。

编码风格与命名规范

YAML 和 HTML/Liquid 使用两个空格缩进,并保持 assets/css/ 下现有的模块化组织方式。新增 CSS 和 JavaScript 文件使用小写 kebab-case 命名。文章必须包含 YAML Front Matter,并参考 _posts/template.md 填写 layouttitlecategoriesdescriptionkeywords。Markdown 标题应保持层级清晰,链接文字应能说明目标,图片使用仓库相对路径。项目未配置自动格式化工具,请避免无关的空白或格式改动。

测试要求

项目目前没有自动化测试套件或覆盖率目标,bundle exec jekyll build 成功是最低验收标准。修改布局、导航、搜索或响应式样式后,还应通过本地服务分别检查桌面端和窄屏效果。重点确认 Liquid 渲染正常、静态资源没有缺失、Front Matter 格式正确。

提交与 Pull Request 规范

历史提交信息通常简短且聚焦,例如 add readme格式化删除未引用图片。提交标题应使用简洁的祈使句,可使用中文或英文;每个提交只包含一个逻辑变更。Pull Request 应说明修改动机和影响路径,注明构建结果,关联相关 Issue;涉及可视化变化时附上修改前后的截图。

安全与 Agent 配置

不要输出或提交 ~/.codex/.env 中的 API 密钥,也不要向 _config.yml 添加新凭据。Codex 默认使用内置 OpenAI Provider 和 gpt-5.5。使用其他 Provider 时,应通过对应 Profile 启动,例如 codex --profile deepseekcodex --profile minimax-cn/model 只能在当前 Provider 内切换模型。

本站总访问量: , 您是第位访客