让 Retype Docs AI-Ready，使用 llms.txt 自动化

Source: Dev.to

保持文档最新是一件事！帮助团队或合作伙伴快速消化变更则是另一件事。在我们公司，我们使用 Retype 来管理文档，并且希望能够让文档 即时具备 AI 能力，以便进行摘要、搜索或内部工具的使用。

于是出现了 retype_llms：一个轻量级的 GitHub Action 与 Python 工具，能够直接从你的 Markdown 文档生成 llms.txt 文件。无需手动导出文件或担心 URL 与图片问题，这个工具会自动处理。

为什么是 llms.txt？

如果你曾尝试将文档喂给 AI 工具或构建搜索索引，你一定了解其中的难点：多个 Markdown 文件、相对图片路径、Front‑matter 头部以及自定义路由都可能导致上下文中断。

retype_llms 通过以下方式解决这些问题：

• 将所有 Markdown 合并为单个结构化文件
• 删除会让 AI 困惑的 YAML front‑matter
• 添加带有文件路径和 URL 的明确 章节标记
• 如有需要，将相对图片路径解析为绝对 URL
• 保留 Retype 的路由逻辑，以确保链接准确

这意味着你的 AI 工具，甚至是分析文档的脚本，都能获得 干净、结构化、可直接使用的内容。

如何融入你的工作流

无论你喜欢使用 Python 脚本还是 GitHub Actions，retype_llms 都能无缝衔接：

• Python 脚本 – 在本地或 CI 中按需生成 llms.txt。
• GitHub Action – 在每次 push 时自动生成 llms.txt，可选地在 Retype 构建站点之前运行。生成的文件会放入 static/ 文件夹，随时可用。

示例：在 Retype Build Action 中使用

你可以在 Retype 构建之前直接集成 retype_llms，确保 llms.txt 始终是最新的：

name: Build Retype Documentation
on:
  push:
    branches: [main]
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Generate llms.txt
        uses: zakaria-chahboun/retype_llms@v2.0.0

      - name: Build Retype
        uses: retypeapp/action-build@latest

      - name: Deploy to GitHub Pages
        uses: retypeapp/action-github-pages@latest
        with:
          update-branch: true

它的设计目标是 无需对现有 Retype 配置做任何改动 😎 —— 只需把它加入工作流，即可运行。

工作原理

该工具遵循 Retype 的逻辑：

• 输入检测 – 自动从 retype.yml 中找到 Markdown 源文件夹。
• 路由生成 – 生成符合 Retype permalink、route 与索引文件规则的 URL。
• Slug 化 – 与 Retype 的小写‑连字符 URL 样式保持一致。
• 统计信息 – 报告文件数量、字数以及估算的 token 数 ✨（对 AI 集成非常实用）。

所有这些都确保 llms.txt 的输出精准映射你的文档结构，无需手动清理。

为什么你会爱上它

• 完全自动化：无需复制或导出文件。
• 链接和图片保持完整，适用于 AI 或脚本。
• 与 GitHub Pages 以及现有 Retype 构建兼容。
• 轻量且易于设置。

快去试试吧 👉

这小小的改动就能 节省数小时的手动工作，让你的文档 几分钟内即可 AI‑ready。

祝文档写作愉快！ 🚀