Skip to content

HagiCode-org/docs

Repository files navigation

HagiCode Documentation

独立的 HagiCode 文档站点,使用 Astro 和 Starlight 构建。

仓库结构

docs/
├── src/
│   ├── content/docs/    # 文档内容(Markdown 和 MDX 文件)
│   │   └── blog/        # 博客文章
│   ├── components/      # 自定义 UI 组件
│   ├── config/          # 导航和配置
│   ├── integrations/    # Astro 集成
│   ├── pages/           # 页面
│   ├── styles/          # 样式文件
│   └── utils/           # 工具函数
├── public/              # 静态资源(图片、图标等)
├── .github/workflows/   # CI/CD 工作流
├── astro.config.mjs     # Astro 配置
├── package.json         # 依赖和脚本
├── tsconfig.json        # TypeScript 配置
└── illustration-management.md  # 配图管理指南

快速开始

安装依赖

npm install

开发模式

npm run dev

文档站点将在 http://localhost:31265 启动。

构建

npm run build

构建输出将生成在 dist/ 目录。

预览构建结果

npm run preview

贡献指南

编辑文档

文档内容位于 src/content/docs/ 目录。编辑 Markdown 文件后,更改将自动在开发服务器中反映。

维护「大模型指南」分类

src/content/docs/llm-guide/src/content/docs/en/llm-guide/ 用于维护模型对比文档,更新时请遵循以下约束:

  1. 每次更新评测结论时,同步更新“测试时间与场景说明”。
  2. 中文与英文页面保持相同章节骨架,避免语言切换信息不一致。
  3. 模型条目至少包含:模型名称、测试时间、代码质量评分、性价比评分。
  4. 建议每月复核一次,若模型能力或价格发生明显变化应立即补充更新。

添加博客文章

  1. src/content/docs/blog/ 创建新文件
  2. 使用日期前缀命名(例如:2026-02-21-my-post.mdx
  3. 添加 frontmatter 元数据

添加静态资源

将图片和其他静态文件放入 public/ 目录。它们在构建时会被复制到 dist/ 目录的根路径。

博客多语言与广告显示维护

当调整 src/components/StarlightHeader.astrosrc/components/MarkdownContent.astrosrc/components/BlogHeaderAd.astrosrc/components/BlogFooterAd.astro 时,请同步检查以下项:

  1. locale 解析链路保持一致:Astro.currentLocale -> starlightRoute.locale -> root
  2. 博客导航在中英文构建产物中都有非空文案(博客 / Blog)。
  3. StarlightAd 头/尾广告区标题、描述、CTA 文案在构建产物中非空。
  4. 语言切换后 Blog 路由保持连续(/blog/ <-> /en/blog/)。

推荐使用以下命令执行构建后验证:

npm run build:verify-blog-i18n
# 或仅验证已构建产物
npm run verify:blog-sidebar-i18n

StarlightAd 线上可见性故障排查

若线上出现“广告方格可见但文字不可见”,优先检查:

  1. 主题变量是否缺失:确认 --color-primary--color-secondary--sl-color-text-high 在目标主题下可解析。
  2. 样式层叠是否覆盖文字颜色:检查是否存在 color: transparent-webkit-text-fill-color: transparent 或高优先级覆盖。
  3. 构建差异:对比本地 dist/ 与线上页面渲染结果,确认构建产物中广告文本节点存在且非空。
  4. 内容源是否为空:确认 public/presets/claude-code/providers/*.jsonpromotion 字段完整,或回退文案可正常渲染。

上线后抽样检查清单

建议每次发布后抽样检查以下页面与项目:

  1. https://docs.hagicode.com/blog/:导航文案显示中文且包含语言切换入口。
  2. https://docs.hagicode.com/en/blog/:导航文案显示英文且可返回中文路径。
  3. 任一中文博客详情页:顶部/底部广告标题、描述、按钮文案可见。
  4. 任一中文博客详情页点击语言切换:路由与文案切换行为符合预期。
  5. 若发现回退文案:确认是否为翻译缺失导致,并记录后续补充计划。

CI/CD

文档通过 GitHub Actions 自动部署到 Azure Static Web Apps。

  • 推送到 main 分支会触发部署
  • Pull Requests 会触发构建验证

相关资源

About

Hagicode 是一款 AI 驱动的代码智能助手,通过创新的 OpenSpec 工作流、多线程并发操作 和 游戏化机制,为开发者带来前所未有的编码体验。

Resources

Stars

Watchers

Forks

Releases

No releases published

Contributors