npm 包 markdown-language-server 使用教程

阅读时长 3 分钟读完

前言

markdown 是常见的文本格式,常用于写作、编写文档等场合。markdown-language-server 是一个使用 Node.js 实现的 markdown 语言服务器,可以提供语法检测、自动补全、代码反引号、代码跳转等功能。本篇文章将详细介绍如何使用 markdown-language-server。

安装

markdown-language-server 可以通过 npm 安装。打开命令行工具,输入以下命令即可安装:

安装完成后,可以使用以下命令检查是否安装成功:

若出现命令行参数列表,则表示安装成功。

使用

markdown-language-server 可以在命令行中单独使用,也可以与编辑器结合使用。本篇文章将以 VS Code 编辑器为例介绍如何使用。

首先,需要在 VS Code 中安装 Markdown Language Server 插件。安装成功后,打开一个 markdown 文件,将自动启用 markdown-language-server。

语法检测

markdown-language-server 能够智能检测 markdown 文件中的语法错误,并给出相应的提示。在编写 markdown 文件时,可以通过编译器的提示及时发现语法问题。

通过修改以下代码,可以制造一些语法错误:

这段代码中有三个连续的标题,markdown 是不支持这样的写法的。当我们将鼠标移动到第二个标题上时,markdown-language-server 会给出相应的提示:

自动补全

markdown-language-server 能够自动补全 markdown 的一些常用语法,能够大大提高编写 markdown 文件的效率。

在编写列表时,只需要输入列表的一级或二级名称,即可自动补全相关代码:

代码反引号

markdown-language-server 能够自动添加代码反引号,让代码更加美观易读:

代码跳转

markdown-language-server 能够自动跳转到代码定义处,方便我们快速查看代码以及对代码进行修改。

在编辑 markdown 文件时,将鼠标放在代码块上方,按下 F12 键即可跳转到定义处。

结语

本篇文章详细介绍了 markdown-language-server 的使用方法,包括语法检测、自动补全、代码反引号、代码跳转等功能。markdown-language-server 能够为我们的编辑工作提供很大的帮助,是前端和后端开发人员不可或缺的工具之一。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600566c081e8991b448e3143

纠错
反馈