npm 包 `lint-md-cli` 使用教程

阅读时长 3 分钟读完

什么是 lint-md-cli?

lint-md-cli 是一个基于 Node.js 平台的 Markdown 文档检查工具。它可以检查 Markdown 文档的语法、格式、拼写等问题,并提供相应的修复方法。

安装

通过 Node.js 的包管理器 npm 进行安装是最简单的方式:

使用

在命令行中运行以下命令来检查一个 Markdown 文件:

如果文件中存在语法、格式、拼写的问题,lint-md-cli 会输出相应的错误信息和建议。

同时,lint-md-cli 还支持自动修复文件中的问题:

配置

如果你想通过配置文件来定制 lint-md-cli 的行为,你可以创建一个 .lintmdrc 文件,在其中编写相关配置。

以下是一份可用的 .lintmdrc 示例配置:

  • rules: 配置规则,包含检查项名称和级别("error""warn")。
  • plugins: 指定要加载的插件。
  • ignore: 忽略检查的文件或目录。

通过配置文件,你可以根据项目的实际情况,灵活定制 lint-md-cli 的检查行为。

示例代码

以下是一份包含 Markdown 错误的示例代码,通过 lint-md-cli 可以自动修复。

-- -------------------- ---- -------
- ----

--------

---------------
--------

- -------

--------

- --- - ---
- -------------
- --- - ---

-------

---

-------

console.log('Hello World!');

通过运行以下命令,lint-md-cli 可以检测并修复该文件:

修复后,文件的内容变为:

-- -------------------- ---- -------
- ----

--------

---------------
--------

- -------

--------

- --- - --- -
- ----- - ----- -
- --- - --- -

-------

---

-------

-------------
------------------ ---------

这是一张图片:

-- -------------------- ---- -------

------------------ ----------------------------------

-- --

------------- -------- -------- ---------------------------------------- ------------- ----------------------------------------------------- -------- ---------------

- ------------------------------------------------------------------------------ --------
------------------------------------------------------------------------------------------------------------------------
纠错
反馈