提示:AI 结果必须带引用;若证据不足会提示“未找到可靠证据”。

    下载 Markdown

    插件系统(v0.4+)

    当前实现的目标:让插件能参与 Markdown 渲染扩展,并在 build 阶段生成额外产物。

    配置

    {
      "plugins": [
        { "name": "@hot-docs/plugin-sitemap", "options": { "siteUrl": "https://example.com" } },
        { "name": "@hot-docs/plugin-feed", "options": { "siteUrl": "https://example.com" } }
      ]
    }
    

    同时支持本地插件文件:

    { "plugins": [{ "path": "./plugins/my-plugin.mjs", "options": { "foo": 1 } }] }
    

    插件声明(package.json#hotDocs)

    {
      "hotDocs": { "type": "plugin", "apiVersion": "1", "entry": "./dist/index.js" }
    }
    

    参考插件

    • @hot-docs/plugin-sitemap:生成 dist/sitemap.xml
    • @hot-docs/plugin-feed:生成 dist/feed.xml(默认仅包含 build 未过滤的 blog 文章)
    • @hot-docs/plugin-search:提供 /search/ 虚拟页面,并生成 dist/search-index.json
    • @hot-docs/plugin-raw-md:输出 dist/__raw__/... 原始 Markdown,并在页面注入“下载 Markdown”链接
    • @hot-docs/plugin-ai-pack:输出 dist/ai/*manifest.json + chunks.json),用于“带引用 AI 问答”的证据数据
    • @hot-docs/plugin-ai-ui:在 docs/blog 页面注入 AI 面板(问本文档/总结/生成步骤/翻译选中),并渲染 citations(回跳、复制链接、证据折叠)

    虚拟页面(routes.pages)

    插件可在 routes 阶段提供“虚拟页面”(dev/build 一致):

    • 适用于:搜索页、重定向页、额外说明页等“不想写 Markdown 文件”的场景
    • 约定:虚拟页面不会覆盖真实 Markdown 页面;若路由冲突,以真实页面为准