让开源，少一点语言距离。
npm包中文文档

@docmd/plugin-llms

中文文档
0.9.9发布于 2026/11/04MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 7.8万

Generate llms.txt context files for AI agents from your docmd site.

原始使用文档
中文原文
文档目录3 节
  1. Features
  2. Documentation
  3. License

@docmd/plugin-llms

Generates llms.txt and llms-full.txt at build time so your documentation is immediately accessible to AI agents - ChatGPT, Claude, Cursor, and any tool that follows the llmstxt.org standard.

Bundled with @docmd/core. Requires siteUrl in your config to produce valid absolute links.

// docmd.config.js
module.exports = {
  siteUrl: 'https://your-site.com',
  plugins: {
    llms: {
      // Optional: Custom system prompt / AI instructions included in context files
      prompt: 'You are an AI assistant helping developers with this project.',
      // Optional: Enable multi-locale generation (llms.<locale>.txt)
      i18n: true
    }
  }
};

Features

  • Standard llms.txt: Curated index of documentation links with descriptions.
  • Section-aware Grouping: Automatically groups files by category/section (using frontmatter section/category or directory structure).
  • Custom System Prompt: Embed specialized AI assistant guidelines into llms.txt, llms-full.txt, and llms.json.
  • Full Context (llms-full.txt): Complete concatenated documentation bundle for large context window models.
  • Machine-readable (llms.json): Structured index with section metadata and priorities.
  • Multi-locale Support: Generates per-locale files when i18n: true.

Part of the docmd documentation engine.

Documentation

See docs.docmd.io for full usage and API reference.

License

MIT

版本与发布记录

@docmd/plugin-llms 共发布 59 个版本，首次发布于 2026/02/16；过去 12 个月发布了 59 个版本。最新版本附带 npm provenance 构建来源证明，可追溯到公开的 CI 构建记录。

版本发布日期距今
0.9.9latest2026/11/049 天前
0.9.82026/10/1727 天前
0.9.72026/09/271 个月前
0.9.62026/09/211 个月前
0.9.52026/09/082 个月前
0.9.42026/08/242 个月前

关于 @docmd/plugin-llms 的常见问题

@docmd/plugin-llms 是什么？

Generate llms.txt context files for AI agents from your docmd site.

如何安装 @docmd/plugin-llms？

在项目目录运行 npm install @docmd/plugin-llms，或使用 pnpm add / yarn add / bun add。

@docmd/plugin-llms 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

@docmd/plugin-llms 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。

@docmd/plugin-llms 需要什么版本的 Node.js？

package.json 的 engines 字段要求 Node.js >=20.0.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

@docmd/plugin-llms 可以商用吗？

@docmd/plugin-llms 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

@docmd/plugin-llms 的下载量有多少？

根据 npm 官方下载统计，@docmd/plugin-llms 在 2026/10/13 – 2026/11/11 这 30 天内被下载 78,474 次，日均约 2,616 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

@docmd/plugin-llms 还在维护吗？

最新版本 0.9.9 发布于 2026/11/04（9 天前）；至今共发布 59 个版本，其中过去 12 个月发布了 59 个；首次发布于 2026/02/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。