# @dsanders11/vscode-markdown-languageservice 中文文档

规范地址：https://npmcn.com/package/%40dsanders11/vscode-markdown-languageservice/

版本：0\.3\.0
npm 元数据更新时间：2023-03-18T04:31:51.237Z
中文译文更新时间：2026-11-12T21:09:06.967Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40dsanders11/vscode-markdown-languageservice
原文对照：https://npmcn.com/package/%40dsanders11/vscode-markdown-languageservice/?lang=original
项目主页：https://github.com/dsanders11/vscode-markdown-languageservice#readme
源码仓库：https://github.com/dsanders11/vscode-markdown-languageservice

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

- 包体积（解压后）：256 kB，45 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\*
- 运行依赖：5 个
- 首次发布：2022-12-03T01:31:04.114Z
- 最新版本发布：2023-03-18T04:31:51.122Z
- 近 30 天下载量：39092（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

马克下调语言服务

## 安装

```sh
npm install @dsanders11/vscode-markdown-languageservice
```

也可以使用：`pnpm add @dsanders11/vscode-markdown-languageservice`、`yarn add @dsanders11/vscode-markdown-languageservice`、`bun add @dsanders11/vscode-markdown-languageservice`

## README

# VS 代码标记语言服务

授权VS代码的Markdown支持的语言服务,取出后可以被其他编辑和工具再用.

## 特征

这个图书馆的目标 [普通马克](https://commonmark.org/)。对其他Markdown方言和扩展的支持不属于该项目的范围.

目前支持的语言特性 :

-   文件链接( 在编辑器中可单击跨度)
    
    支持的链接包括:
    
    -   链接当前文件内的标题 : `[text](#header)`
    -   文件的绝对和相对链接 : `[text](path/to/file.md)`
    -   参考链接 : `[text][link-name]`
-   文号
    
    在下标记文件中查找所有信头
    
-   工作空间符号
    
    在工作空间找到所有标记下文件的所有标题 .
    
-   折叠范围
    
    折叠范围为:
    
    -   标题部分
    -   区域科
    -   名单
    -   块元素
-   智能选择( 扩展选择)
    
-   完成情况
    
    支持完成下列工作:
    
    -   链接到信头
    -   路径链接
    -   参考链接
-   查找所有引用
    
    支持查找下列参考文献:
    
    -   页眉
    -   路径链接
    -   链接中的裂痕
    -   参考链接
-   定义
    
    支持查找定义头和引用链接.
    
-   重命名
    
    支持重命名信头和链接.
    
-   组织链接定义.
    
    文件中的组合和类型链接定义,可选地删除未使用的定义.
    
-   代码动作
    
    -   提取文件中链接到文件底部链接定义的所有出错 .
    -   删除重复或未使用的链接定义的快速修正.
-   诊断(错误报告)
    
    支持生成无效链接的诊断:
    
    -   参考文献.
    -   当前文件中的标题 .
    -   工作区的文件 .
    -   其他文件中的标题 .
    
    还可为以下目的生成诊断:
    
    -   未使用的联系定义.
    -   重复链接定义.
-   在文件重命名上更新链接
    
    创建编辑器, 当工作空间中的文件/目录被重命名或移动时更新所有链接 .
    

## 使用量

要开始使用此库, 请先安装到您的工作空间 :

```bash
npm install vscode-markdown-languageservice
```

要使用语言服务,首先需要创建使用语言服务的实例 `createLanguageService`我们使用依赖性注射,以便尽可能多地使用语言服务.

```ts
import * as md from 'vscode-markdown-languageservice';

// Implement these
const parser: md.IMdParser = ...;
const workspace: md.IWorkspace = ...;
const logger: md.ILogger = ...;

const languageService = md.createLanguageService({ workspace, parser, logger });
```

在创建服务后,您可以询问它所支持的语言特性:

```ts
// We're using the vscode-language types in this demo
// If you want to use them, make sure to run:
//
//     npm install vscode-languageserver vscode-languageserver-textdocument
//
// However you can also bring your own types if you want to instead.

import { CancellationTokenSource } from 'vscode-languageserver';
import { TextDocument } from 'vscode-languageserver-textdocument';

const cts = new CancellationTokenSource();

// Create a virtual document that holds our file content
const myDocument = TextDocument.create(
    URI.file('/path/to/file.md').toString(), // file path
    'markdown', // file language
    1, // version
    [ // File contents
        '# Hello',
        'from **Markdown**',
        '',
        '## World!',
    ].join('\n')
);

const symbols = await languageService.getDocumentSymbols(myDocument, { includeLinkDefinitions: true }, cts.token);
```

见 [实例. cjs](https://npmcn.com/package/%40dsanders11/vscode-markdown-languageservice/example.cjs) 用于提供完整的、最低限度的语文服务。 您可以使用 `node example.cjs`。 。 。 .

## 其他链接

-   [VS 代码的 Markdown 语言服务器](https://github.com/microsoft/vscode/blob/main/extensions/markdown-language-features/server/)
-   [TextMate语法 VS 代码用于突出显示的 Markdown 语法](https://github.com/microsoft/vscode-markdown-tm-grammar)

## 捐款

如果你有兴趣贡献

1.  克隆这个还原
2.  使用 `npm install`
3.  开始使用汇编 `npm run watch`

您可以使用 `npm test` 或以 VS 代码打开项目并按 `F5` 调试.

## 常见问题

### @dsanders11/vscode-markdown-languageservice 是什么？

马克下调语言服务

### 如何安装 @dsanders11/vscode-markdown-languageservice？

在项目目录运行 npm install @dsanders11/vscode-markdown-languageservice，或使用 pnpm add / yarn add / bun add。

### @dsanders11/vscode-markdown-languageservice 支持 TypeScript 吗？

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

### @dsanders11/vscode-markdown-languageservice 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @dsanders11/vscode-markdown-languageservice 需要什么版本的 Node\.js？

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

### @dsanders11/vscode-markdown-languageservice 可以商用吗？

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

### @dsanders11/vscode-markdown-languageservice 的下载量有多少？

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

### @dsanders11/vscode-markdown-languageservice 还在维护吗？

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