# @docmd/plugin-llms 中文文档

规范地址：https://npmcn.com/package/%40docmd/plugin-llms/

版本：0\.9\.9
npm 元数据更新时间：2026-11-03T17:30:36.917Z
中文译文更新时间：2026-11-12T13:56:35.514Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40docmd/plugin-llms
原文对照：https://npmcn.com/package/%40docmd/plugin-llms/?lang=original
项目主页：https://docmd.io/
源码仓库：https://github.com/docmd-io/docmd

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：18.2 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：0 个
- 首次发布：2026-02-16T12:56:00.429Z
- 最新版本发布：2026-11-03T17:30:36.419Z
- 近 30 天下载量：78474（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：59（近 12 个月 59 个）

## 中文简介

从您的 docmd 站点为 AI 代理生成 llms.txt 上下文文件 .

## 安装

```sh
npm install @docmd/plugin-llms
```

也可以使用：`pnpm add @docmd/plugin-llms`、`yarn add @docmd/plugin-llms`、`bun add @docmd/plugin-llms`

## README

# @ docmd/ plugin- llms (英语)

生成 `llms.txt` 财务报告和审定财务报表 `llms-full.txt` 因此,您的文档可以被AI代理即时访问 - ChatGPT, Claude, Cursor [维基百科中的相关条目: 维基语录链接:名人名言](https://llmstxt.org/) 标准.

装满了 `@docmd/core`。要求 `siteUrl` 在配置中生成有效的绝对链接.

```js
// 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
    }
  }
};
```

### 特征

-   **标准 `llms.txt`**: 描述文件链接的解析索引.
-   **分区意识分组**: 按类别/ 区域自动分组文件( 使用前题) `section`编号 :`category` 或目录结构).
-   **自定义系统提示**: 将专门的AI助理准则纳入 `llms.txt`, (中文(简体) ), `llms-full.txt`,以及 `llms.json`。 。 。 .
-   **整个背景`llms-full.txt`(中文(简体) )**: 大型上下文窗口模型的完整压缩文档捆绑.
-   **机器可读取(`llms.json`(中文(简体) )**: 结构化指数,并有节元数据和优先事项.
-   **多地支助**: 当每个本地生成文件时 `i18n: true`。 。 。 .

部分 **[医生](https://github.com/docmd-io/docmd)** 文档引擎.

## 文档

见 **[文件.doc.docmd.io](https://docs.docmd.io/)** 用于充分使用和API参考.

## 许可证

麻省理工学院

## 常见问题

### @docmd/plugin-llms 是什么？

从您的 docmd 站点为 AI 代理生成 llms\.txt 上下文文件 \.

### 如何安装 @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 和提交记录判断。

