# @docmd/core 中文文档

规范地址：https://npmcn.com/package/%40docmd/core/

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

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

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

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

- 包体积（解压后）：418 kB，51 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：22 个
- 首次发布：2026-02-12T02:37:12.825Z
- 最新版本发布：2026-11-03T17:27:21.063Z
- 近 30 天下载量：79509（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：65（近 12 个月 65 个）

## 中文简介

人类和机器的文档编译器. 一个Markdown源,一个命令——共同生成网站,搜索,AI上下文和知识格式.

## 安装

```sh
npm install @docmd/core
```

也可以使用：`pnpm add @docmd/core`、`yarn add @docmd/core`、`bun add @docmd/core`

## README

[![docmd](https://github.com/docmd-io/docmd/blob/main/packages/ui/assets/images/docmd-logo-dark.png?raw=true)](https://docmd.io/)  

**人类和机器文献.**  
1 Markdown source ~网站,搜索,AI上下文,代理,和知识格式.

[![npm version](https://img.shields.io/npm/v/@docmd/core.svg?style=flat-square&color=CB3837)](https://www.npmjs.com/package/@docmd/core) [![monthly downloads](https://img.shields.io/npm/dm/@docmd/core.svg?style=flat-square&color=38bd24)](https://www.npmjs.com/package/@docmd/core?activeTab=versions) [![GitHub stars](https://img.shields.io/github/stars/docmd-io/docmd?style=flat-square&logo=github)](https://github.com/docmd-io/docmd) [![license](https://img.shields.io/github/license/docmd-io/docmd.svg?style=flat-square&color=A31F34)](https://github.com/docmd-io/docmd/blob/main/LICENSE)

#### [网站](https://docmd.io/)  • 妇女  [文档](https://docs.docmd.io/)  • 妇女  [云中继](https://cloud.docmd.io/)  • 妇女  [现场编辑器](https://live.docmd.io/)  • 妇女  [代理技能](https://github.com/docmd-io/docmd-skills)  • 妇女  [问题](https://github.com/docmd-io/docmd/issues)

  
[![docmd documentation — light and dark mode preview](https://raw.githubusercontent.com/docmd-io/docmd/refs/heads/main/assets/docmd-cover.webp)](https://docmd.io/)

## 快速启动

在 Markdown 文件文件夹中的点名 :

```bash
npx @docmd/core dev
```

打开 `http://localhost:3000`。 。 。 .

就是这样。 导航由您的文件结构生成 。 不需要配置文件、前题或框架 .

准备好部署时:

```bash
npx @docmd/core build
```

docmd生成一个静态站点,可以被部署到Vercel, Cloudflare Pages,Netlify,GitHub Pages,S3,NGINX,Caddy或任何其他静态主机.

**需要节点.js 20+.**

**全球安装和多克**  

全球安装 :

```bash
npm install -g @docmd/core

# or
pnpm add -g @docmd/core
```

然后说:

```bash
docmd dev
docmd build
```

或与多克同跑:

```bash
docker run -p 3000:3000 ghcr.io/docmd-io/docmd:latest
```

> 将 Docker 图像固定为可复制生产建筑的特定释放 .

## 一个来源。 每个输出.

docmd是一个开源文档编译器.

Docmd 将同一源码编译成供读者、搜索引擎、LLMs、编码代理和知识系统使用的产出,而不是仅作为网站的输入.

```text
Markdown
   │
   ▼
 docmd
   │
   ├── → Static documentation site
   ├── → Offline search index
   ├── → llms.txt / llms-full.txt
   ├── → Open Knowledge Format (OKF)
   ├── → Sitemap + SEO metadata
   ├── → robots.txt + Open Graph
   ├── → MCP interface for AI agents
   └── → AI Assistant context
```

一出源树. 一条管道 没有单独的文档和AI知识堆栈需要维护.

## 为什么是医生?

越来越多的文件读者不止一个.

人们需要一个快速,通航的网站. 搜索引擎需要结构化元数据. 法学硕士课程需要干净的背景。 编码代理需要工具和协议. RAG系统需要结构化的知识.

docmd在将Markdown保留在中心的同时将这些东西一起建造.

[![docmd comparison with other documentation tools](https://raw.githubusercontent.com/docmd-io/docmd/refs/heads/main/assets/docmd-comparison.webp)](https://docs.docmd.io/comparison/)  
**参见与 [Docusaurus、Mintlify和其他文档工具 –](https://docs.docmd.io/comparison/)**

## 特征

### 零配置, 即时启动

任何Markdown文件夹的点数和它运行。 导航是自动从您的文件结构生成的——没有锅炉板,前置物,或构建启动所需的管道.

### 轻而易举,无所不在

docmd生成静态的HTML,最小的香草JavaScript和快的SPA风格导航. 离线全文搜索,站点地图,Canonic URL,Open Graph元数据等基本内容被构建到输出中.

### AI 代理准备( A)

docmd将机器可读文档作为构建的一部分,而不是单独的出版工作流程.

-   **大赦国际助理** ——基于文档的RAG能动聊天
-   **MCP 服务器** ——让兼容的编码代理搜索、读取和验证您的文件
-   **`llms.txt` 编号 : `llms-full.txt`** ——完整的LLM可读文件背景
-   **开放知识格式( OKF)** 用于AI和RAG系统的结构化知识包
-   **代理技能** ——LLMS和编码代理的可再用指令
-   **复制为 Markdown / 复制上下文** ——直接从浏览器中提取干净的上下文
-   **语义搜索** ——可选向量检索与内置关键字搜索

### 建为规模

-   以地方意识搜索和产出实现国际化
-   多个文件发布版本
-   单重机和多项目设置的工作空间
-   API 文档的 OpenAPI 3.x 渲染
-   内建模板,自定义 CSS/JavaScript,以及轻/暗模式

## AI 助手和云中继器

docmd包括一个基于你文档的RAG授权AI助理.

您可以连接到自己的后端或本地的AI提供商. 如果你的文件是作为静态站点部署的, **docmd 云中继器** 提供主机桥.

```text
Your documentation
        │
        ▼
 @docmd/plugin-ai
        │
        ▼
 docmd Cloud Relay
        │
        ▼
 Your AI provider
```

Cloud Relay安全地向您选择的提供者发送AI请求,因此提供者证书不需要被运至浏览器,也无需操作AI后端.

**Cloud Relay可自由使用自有的AI提供者密钥.**

-   带上自己的供应商和模特儿
-   保留客户端的提供者证书
-   静态托管工程
-   没有用于部署或维护的AI后端
-   使用能见度和读者问题见解
-   从一个账户连接多个文档项目

**[设置 Cloud 中继](https://cloud.docmd.io/)** 二. 支助 [AI 助理文件 −](https://docs.docmd.io/guides/ai/ai-assistant/)

> 云中道自在. 您所选择的 AI 提供者可单独收取模型使用费.

## 国 际

```bash
docmd dev            # Start the local development server
docmd build          # Build for production
docmd live           # Start the browser-based Live Editor
docmd init           # Create a configuration file
docmd doctor         # Check configuration and plugin status
docmd validate       # Check internal documentation links
docmd migrate        # Migrate from Docusaurus, VitePress, MkDocs, or Starlight
docmd deploy         # Generate deployment configuration
docmd mcp            # Run the MCP server over stdio
docmd add <name>     # Install a plugin or template
docmd stop           # Stop running docmd development servers
```

**见完整 [CLI 命令 •](https://docs.docmd.io/reference/cli-commands/)**

## 插件

docmd是围绕一个插件系统构建的. 有核心的通用文献能力船,同时在需要时可以安装可选插件.

| 插件 | 状态 | 说明 |
| :-- | :-: | :-- |
| `ai` | 核心 | RAG 有本地供应商BYOK和Cloud Relay的AI助理 |
| `search` | 核心 | 带有可选语义搜索的离线关键词搜索 |
| `seo` | 核心 | SEO 和 开放式图元数据 |
| `sitemap` | 核心 | 生成 `sitemap.xml` |
| `git` | 核心 | Git 历史和最近更新的元数据 |
| `analytics` | 核心 | 轻量级分析一体化 |
| `llms` | 核心 | 生成 `llms.txt` 财务报告和审定财务报表 `llms-full.txt` |
| `okf` | 核心 | 打开知识格式捆绑 |
| `mermaid` | 核心 | 美人鱼图渲染 |
| `openapi` | 核心 | OpenAPI 3.x 文档渲染器 |
| `pwa` | 可选 | 进步的Web App和离线导航 |
| `threads` | 可选 | 内部文件讨论 _(由@svallory) (中文(简体) )_ |
| `math` | 可选 | KaTeX / LaTeX 渲染 |

安装可选插件 :

```bash
docmd add <plugin-name>
```

**构建自己的 : [插件开发指南](https://docs.docmd.io/development/building-plugins/)**

## 配置

配置是可选的 .

添加 `docmd.config.json`, (中文(简体) ), `docmd.config.ts`,或 `docmd.config.js` 当您需要更多控制时, 在您的工程根中 :

```json
{
  "title": "My Project",
  "url": "https://docs.myproject.com",
  "src": "./docs",
  "out": "./dist"
}
```

当需要动态值时,可以使用TypeScript和JavaScript配置.

**[配置参考](https://docs.docmd.io/configuration/overview)**

## 程序化 API

使用来自Node.js脚本的docmd,CI管道,或自定义构建系统.

```javascript
import { build } from '@docmd/core';

// Build documentation programmatically.
await build('./docmd.config.json', { isDev: false });
```

支持共同JS和无害环境管理.

**[节点 API 参考](https://docs.docmd.io/development/node-api-reference/)**

## 移徙

现有文件不需要从零开始.

```bash
docmd migrate
```

移徙工具可用于辅助文件框架,包括Docuraus、VitePress、MkDocs和Starlight.

**[移民证件 \*\*\*](https://docs.docmd.io/)**

## 开源

你的文献是你们项目的知识核心 它属于您 Git 仓库中的平版Markdown 文件—— 便携式, 版本控制和可审计 .

**Docmd编译器和官方核心插件是MIT许可的,并将保持自由使用,没有付费墙编译器的功能.**

生成的文件可以在任何地方托管,不需要docmd托管的基础设施.

## 社区

-   **文档** → [文件.doc.docmd.io](https://docs.docmd.io/)
-   **问题和想法** → [GitHub 讨论](https://github.com/orgs/docmd-io/discussions)
-   **错误特性请求( T)** → [GitHub 问题](https://github.com/docmd-io/docmd/issues)
-   **捐款** → [捐款额](https://npmcn.com/package/%40docmd/core/.github/CONTRIBUTING.md)
-   **路线图** → [GitHub 讨论](https://github.com/orgs/docmd-io/discussions/2)

## 支持文档d

如果 docmd对您有用:

-   给存储器一个QQ
-   和某个建筑文件分享吧
-   打开问题、 提供修正或构建插件
-   [GitHub 赞助开发](https://github.com/sponsors/mgks)

## 许可证

MIT许可证。 见 [自由主义](https://npmcn.com/package/%40docmd/core/LICENSE) 详细情况.

## 常见问题

### @docmd/core 是什么？

人类和机器的文档编译器\. 一个Markdown源,一个命令——共同生成网站,搜索,AI上下文和知识格式\.

### 如何安装 @docmd/core？

在项目目录运行 npm install @docmd/core，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 docmd，可以用 npx docmd 直接运行。

### @docmd/core 支持 TypeScript 吗？

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

### @docmd/core 支持 ESM 还是 CommonJS？

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

### @docmd/core 需要什么版本的 Node\.js？

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

### @docmd/core 可以商用吗？

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

### @docmd/core 的下载量有多少？

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

### @docmd/core 还在维护吗？

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