coc-markdownlint 项目启动与配置教程

1. 项目目录结构及介绍

coc-markdownlint 项目是一个为 Vim/Neovim 编辑器提供 markdown 语法检查的 coc.nvim 插件。项目的目录结构如下：

• .github/：存放与 GitHub 相关的配置文件，如代码审查、工作流等。
• .gitignore：定义 Git 忽略的文件和目录。
• CONTRIBUTING.md：贡献者指南，说明如何贡献代码。
• LICENSE：项目的许可证文件。
• README.md：项目说明文件。
• src/：源代码目录，包含项目的核心实现。
• tsconfig.json：TypeScript 配置文件。
• package.json：项目依赖和脚本。
• package-lock.json：锁定项目的依赖版本。

每个目录和文件的作用已在上述列表中简要介绍。

2. 项目的启动文件介绍

package.json 文件是 Node.js 项目的主要配置文件，它定义了项目的元数据、依赖关系以及可执行脚本。在 coc-markdownlint 项目中，package.json 的关键部分如下：

{
  "name": "coc-markdownlint",
  "version": "1.0.0",
  "description": "markdownlint extension for coc.nvim",
  "main": "index.js",
  "scripts": {
    "build": "tsc"
  },
  "dependencies": {
    "markdownlint": "^0.22.0"
  },
  "devDependencies": {
    "typescript": "^5.8.3"
  }
}

这里定义了项目的入口文件为 index.js，并提供了一个 build 脚本用于编译 TypeScript 代码。

3. 项目的配置文件介绍

项目的配置主要通过以下文件进行：

• coc-settings.json： coc.nvim 的配置文件，可以在这里设置 coc-markdownlint 的相关配置。
• .markdownlintrc：markdownlint 的配置文件，用于定义 markdown 语法检查的规则。

例如，你可以在 coc-settings.json 中添加以下配置：

{
  "markdownlint": {
    "onOpen": true,
    "onChange": true,
    "onSave": true,
    "config": {
      "default": true,
      "line_length": false
    }
  }
}

这里设置了在文件打开、更改和保存时进行语法检查，并定义了一些特定的规则。

在 .markdownlintrc 文件中，你可以定义类似以下的规则：

{
  "default": true,
  "line_length": false
}

这表示默认启用所有规则，但关闭了行长度检查规则。