mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-09-30 06:13:14 +00:00
c7e5d2a446
SDK 仓此前**没有任何地方指向文档站** —— README 不写、GitHub 仓的
homepage 字段也是空的，于是从仓首页根本走不到 sdk.homeagent.jianfgit.xyz。
文档站本身一直在线（106 个文件的 mkdocs 产物），只是没人从仓里指过去。
本次补上：
- README.md / README_EN.md 顶部加文档站入口（快速开始 / API 参考 / 能力边界
/ llms.txt + llms-full.txt 的 agent 直读入口），并在末尾加「文档」章节
列出全部页面的直链。
- mkdocs.yml 的社交链接由 gitcode 改指 GitHub，并**新增** gitcode 镜像入口与
介绍站入口（国内直连 gitcode 更快，海外/权威源看 GitHub，两个都留）。
- docs/guide/getting-started.md 的 `git clone` 地址改为 GitHub 仓名
（homeagentsdk），并写明「release 附件暂时仍在 gitcode」这个事实。
★ 刻意**不**改的东西：Go 模块路径 `gitcode.com/JianFeeeee/homeagent-sdk`。
改模块路径会让所有现有插件的 go.mod 全面失效，属于破坏性变更，
与「仓库托管位置迁移」是两件事。
关于 GitHub 侧没有 release 条目（因此不能写 releases/latest/download/...，
那会 404）：已在 README 里如实写明 —— 二进制目前只在 gitcode 的 release 附件里，
GitHub 从下一个 SDK 版本（v1.4.0）起才会同步发布。
验证：两份 README 里 28 个 URL 全部实测 200；文档站重建（106 文件）并部署，
线上 `git clone` 已是 GitHub 地址、旧 gitcode clone 地址 0 次、
三个社交入口名称正确。
146 lines
4.7 KiB
YAML
146 lines
4.7 KiB
YAML
# HomeAgent 插件 SDK 文档站配置。
|
||
#
|
||
# 设计取舍：
|
||
# - 每页顶部都放「版本 + 编辑链接」，因为 SDK 与内核的协议版本会错配，
|
||
# 读者必须先能确认自己看的是哪一版。
|
||
# - 中文检索依赖 jieba（已装）；英文走内置分词。两者都不要额外服务。
|
||
# - docs/api/*.md 是**生成物**（tools/apidoc/gensite），页首会写明，防止手改。
|
||
|
||
site_name: HomeAgent 插件 SDK
|
||
site_description: 用 Go 或 Lua 为 HomeAgent 编写插件 —— API 参考与开发指南
|
||
site_url: https://sdk.homeagent.jianfgit.xyz/
|
||
copyright: MIT 许可 · JianFeeeee
|
||
|
||
# 主题覆盖目录：只覆盖 footer.html（补备案号，见该文件里的说明）。
|
||
docs_dir: docs
|
||
site_dir: site_build
|
||
|
||
theme:
|
||
name: material
|
||
language: zh
|
||
# custom_dir 必须写在 theme 下（顶层会被判为未知配置）。
|
||
custom_dir: overrides
|
||
# 品牌图标：与主站 introduce 同一份 logo（曾用 Material 默认，不是我们的）。
|
||
logo: assets/logo-mark.svg
|
||
favicon: assets/logo.svg
|
||
features:
|
||
- navigation.instant
|
||
- navigation.instant.progress
|
||
- navigation.tracking
|
||
- navigation.tabs
|
||
- navigation.sections
|
||
- navigation.indexes
|
||
- navigation.top
|
||
- toc.follow
|
||
- search.suggest
|
||
- search.highlight
|
||
- search.share
|
||
- content.code.copy
|
||
- content.code.annotate
|
||
- content.action.edit
|
||
palette:
|
||
- media: "(prefers-color-scheme: light)"
|
||
scheme: default
|
||
primary: indigo
|
||
accent: indigo
|
||
toggle:
|
||
icon: material/weather-night
|
||
name: 切换到深色
|
||
- media: "(prefers-color-scheme: dark)"
|
||
scheme: slate
|
||
primary: indigo
|
||
accent: indigo
|
||
toggle:
|
||
icon: material/weather-sunny
|
||
name: 切换到浅色
|
||
icon:
|
||
repo: fontawesome/brands/git-alt
|
||
|
||
plugins:
|
||
- search:
|
||
lang:
|
||
- zh
|
||
- en
|
||
separator: '[\s\u200b\-]'
|
||
# 中文按词切（jieba），否则整句变一个 token，检索不到。
|
||
jieba_dict: null
|
||
|
||
markdown_extensions:
|
||
- admonition
|
||
- attr_list
|
||
- def_list
|
||
- footnotes
|
||
- md_in_html
|
||
- tables
|
||
- toc:
|
||
permalink: true
|
||
toc_depth: 3
|
||
- pymdownx.details
|
||
# Material 的图标语法 :material-xxx: / :octicons-xxx: 依赖这个扩展。
|
||
# 没开时它们会**原样显示为文本**（实测首页四个卡片全花了）。
|
||
- pymdownx.emoji:
|
||
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||
- pymdownx.highlight:
|
||
anchor_linenums: true
|
||
- pymdownx.inlinehilite
|
||
- pymdownx.snippets
|
||
- pymdownx.superfences
|
||
- pymdownx.tabbed:
|
||
alternate_style: true
|
||
|
||
extra:
|
||
generator: false
|
||
social:
|
||
# 主仓已迁到 GitHub；gitcode 保留为国内镜像（源码同步）。
|
||
# 两个链接都放，是因为国内直连 gitcode 更快，而海外/权威源看 GitHub。
|
||
- icon: fontawesome/solid/code
|
||
link: https://github.com/JianFeeeee/homeagentsdk
|
||
name: SDK 源码（GitHub）
|
||
- icon: fontawesome/solid/code-branch
|
||
link: https://gitcode.com/JianFeeeee/homeagent-sdk
|
||
name: gitcode 镜像（国内）
|
||
- icon: fontawesome/solid/house
|
||
link: https://introduce.homeagent.jianfgit.xyz/
|
||
name: HomeAgent 介绍站
|
||
# 自定义检索端点在 docs/javascripts/api-search.js 里注册，
|
||
# 索引文件由 gensite 产出：docs/assets/api-index.json
|
||
|
||
nav:
|
||
- 首页: index.md
|
||
- 快速开始:
|
||
- 环境与工具链: guide/getting-started.md
|
||
- 第一个 Go 插件: guide/first-plugin.md
|
||
- 第一个 Lua 插件: guide/first-lua-plugin.md
|
||
- API 参考:
|
||
- api/index.md
|
||
- 工具（Tools）: api/tools.md
|
||
- 阶段钩子（Stages）: api/stages.md
|
||
- 记忆（Memory）: api/memory.md
|
||
- 输入/输出通道: api/channels.md
|
||
- 配置（Settings）: api/settings.md
|
||
- 生命周期（Lifecycle）: api/lifecycle.md
|
||
- 事件（Events）: api/events.md
|
||
- LLM 调用: api/llm.md
|
||
- 常量与枚举: api/constants.md
|
||
- 桥接装配点: api/bridge.md
|
||
- 其他类型: api/misc.md
|
||
- 仅内置插件可用: api/builtin-only.md
|
||
- 指南:
|
||
- 能力边界（哪些 API 外部可用）: guide/capability-boundary.md
|
||
- 工具并发声明（ParallelSafe/Serial）: guide/parallel-tool-declaration.md
|
||
- 流式多 tool_call（适配器透传 index）: guide/stream-tool-call-index.md
|
||
- 场景记忆（按场合召回）: guide/scene-memory.md
|
||
- 打包与发布: guide/packaging.md
|
||
- 多平台构建: guide/multi-platform.md
|
||
- 受限 SDK 与安全: guide/security.md
|
||
- 示例插件:
|
||
- 总览: examples/index.md
|
||
- 版本与兼容: versions.md
|
||
|
||
extra_css:
|
||
- stylesheets/extra.css
|
||
|
||
extra_javascript:
|
||
- javascripts/api-search.js
|