mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-03 15:44:11 +00:00
255d6479ad
三件事，都是「站点上线后看出来的」问题。 ## ① 图标用的是 Material 默认，不是我们的 站上 favicon 是 mkdocs-material 自带的那张（`assets/images/favicon.png`）， 与主站 introduce 不一致。改为引入主站同一份 logo： - `docs/assets/logo.svg` —— 原样（浅色底，适合 favicon） - `docs/assets/logo-mark.svg` —— 去掉底色矩形（否则在靛蓝页头上是个白方块） `theme.favicon` / `theme.logo` 分别指向它们。实测子页面路径也正确 （mkdocs 生成 `../../assets/logo.svg`，不是错误的相对路径）。 ## ② 缺备案号 `introduce` 底部有 ICP + 公安备案，文档站没有。Material 的 footer 只渲染 `config.copyright` 一个字符串，塞不进「两条带链接的备案」——所以覆盖了 `overrides/partials/footer.html`（`theme.custom_dir`），并顺带把许可也写进底部， 读者在任何一页都能看到，不必翻到首页。 ## ③ 没有给 agent 的入口 站点是给人看的（HTML + 主题 + JS 搜索），但越来越多读者是 agent。让它们爬 HTML 既浪费 token（样板占大头）又容易漏内容。 新增 `tools/apidoc/gensite/agent.go`，随构建产出： | 路径 | 内容 | |---|---| | `/llms.txt` | 站点目录：每页一行，带 URL 与一句话说明（4.3KB）| | `/llms-full.txt` | 全部文档正文拼成一份，可一次读完（115KB）| | `/<page>.md` | 每个页面的 Markdown 原文，含生成的 API 页（text/markdown）| 沿用 llms.txt 社区约定：`llms.txt` 读目录、`llms-full.txt` 一次读全。 **一个必须处理的坑**：mkdocs 只把 `.md` **渲染**成 HTML，不会把 Markdown 放进产物目录 —— 那样 `llms.txt` 里的链接会全部 404。所以 `build.sh` 增加了 第 4 步 `copy_agent_files`，在构建后把 23 个 Markdown 复制进 `site_build/`。 `docs/llms-full.txt` 已 gitignore：它是派生件，改任何一页都会整份重写， 进版本库只产生噪声（`llms.txt` 索引小且稳定，仍提交）。 验证：`mkdocs build --strict` 零告警；favicon/logo 可取（200，naturalWidth=400）； 三页底部均含两个备案号；4 个 agent 入口均可访问且 content-type 正确。
48 lines
1.0 KiB
Plaintext
48 lines
1.0 KiB
Plaintext
# Build artifacts
|
||
*.so
|
||
*.dll
|
||
*.o
|
||
*.exe
|
||
*.hmap
|
||
plugin.json
|
||
|
||
# Build output directories
|
||
build/
|
||
dist/
|
||
|
||
# plugindev 预编译二进制：只作为 release 附件分发，不进仓库历史。
|
||
# 此前 5 个平台各 26-28MB 被 git 跟踪（约 137MB），每次重编都在历史里
|
||
# 再叠一份，而它们本质是可从源码复现的产物。
|
||
bin/
|
||
|
||
# Test artifacts
|
||
testdist/
|
||
|
||
# Logs
|
||
*.log
|
||
|
||
# Generated bridge files
|
||
z_bridge_gen.go
|
||
z_entry.c
|
||
|
||
# Binaries (except pre-built distributions in bin/)
|
||
/plugindev
|
||
*_debug*
|
||
|
||
# Pre-built plugindev binaries in bin/ should be tracked
|
||
!bin/plugindev*
|
||
!bin/*.exe
|
||
|
||
# plugindev binary in tools/
|
||
tools/plugindev/plugindev
|
||
|
||
# 文档站构建产物（由 tools/apidoc/build.sh 生成）
|
||
site_build/
|
||
# mkdocs 缓存
|
||
.cache/
|
||
|
||
# agent 入口的「全文汇总」是派生件：由 gensite 把 docs/ 下所有 Markdown 拼成一份，
|
||
# 每次改任何一页都会整份重写（115KB），进版本库只产生噪声。它由构建产出，
|
||
# llms.txt（索引，小且稳定）仍提交。
|
||
docs/llms-full.txt
|