跳到正文
v0.6.5

构建产物参考

canofold build 把文档编译成可以直接部署的静态站点,默认写入 .canofold/dist。每个页面都有包含完整正文的 HTML;默认还会在旁边生成 Markdown 原文,关闭 markdownMirror 后则不生成。目录中还包括主题样式、交互资源、搜索索引以及按配置生成的 SEO 和 AI 文件。

完整重建先在临时目录生成产物,成功后再原子替换现有输出;构建失败时保留上一次成功结果。

      • index.html
      • 404.html
        • canofold.css
          • {locale}.json
        • manifest.json
              • *.jsonl
      • llms.txt
      • llms-full.txt
      • sitemap.xml
      • robots.txt
      • redirects.json
          • index.html
          • index.md
表格
页面 index.html始终包含完整正文的静态页面
页面 index.mdmarkdownMirror 启用构建时使用的页面 Markdown/MDX 源文
assets/canofold.css始终默认主题、Token 和用户样式
assets/canofold-markdown/*页面存在交互 behavior 且未配置 Demo Engine内置原生增强入口与按需富交互代码
assets/canofold-demos/*配置 Demo Engine原生增强器、组件 Demo、按需 chunk 与组件 CSS 共用的 Vite 构建图
assets/fonts/*启用 math 插件且至少一页包含数学KaTeX 的完整 WOFF2 字体集
search/*默认 compact Provider 启用按版本和语言生成的单文件索引
pagefind/*配置 pagefind()按查询加载、按语言和版本过滤的分块索引
robots.txt始终搜索引擎抓取策略
sitemap.xml配置 siteUrl站点绝对 URL 清单
redirects.json配置重定向托管平台规则清单
ai/pages.jsonai.pageIndex 启用按 ai.versions 范围生成的基础 AI 页面索引
ai/manifest.json / ai/content/*ai.fullContent 启用有版本、有语言分区且单分片有大小上限的完整 AI 语料
其他 ai/* / llms*.txt对应 AI 开关启用AI 与 RAG 消费

标题、段落和普通列表不依赖客户端 JavaScript。复制、Tabs、Details 和文件树等基础行为使用原生 DOM;可排序表格、图片预览和画廊按需加载 React,图表客户端由对应插件按页加载。未配置 math 插件或没有数学内容的站点不输出 KaTeX CSS 或字体。

robots.txt 默认写入 Allow: /,配置 seo: { robots: 'disallow' } 后改写为 Disallow: / 且不声明 Sitemap。该文件只表达爬虫偏好;私有站点仍必须在托管层保护所有产物。

每次构建还会在部署目录之外写入 .canofold/cache/build-report.json。报告记录页面、语言、版本、构建模式、缓存命中、变更页面和耗时;每类内置产物的启用状态、计划与实际路径、文件数、字节数和缺失路径;以及额外产物与相对上一次有效构建的移除路径。removalBaseline: false 表示没有可比较的旧清单。报告不含文档正文,也不会被部署为公开页面。