Lint-MD使用手册

Lint-MD使用手册

lint-md:books: 检查中文 markdown 编写格式规范的命令行工具，基于 AST，方便集成 CI，写博客 / 文档必备。支持 API 调用！项目地址:https://gitcode.com/gh_mirrors/li/lint-md

---

一、项目目录结构及介绍

Lint-MD作为一个专注于检查中文Markdown格式规范的开源工具，其目录结构精心设计以适应模块化和可扩展性。以下是典型的核心目录结构概述：

lint-md/
│
├── packages/
│   ├── ast-plugin      # AST插件机制相关代码，用于扩展Markdown解析规则
│   ├── lint-md         # 核心模块，包含Markdown文件的lint功能实现
│   └── @lint-md/cli    # 命令行界面(CLI)工具，便于用户在终端操作
│
├── src/               # 源代码文件夹，主要的开发区域
│
├── tests/             # 自动化测试用例集合，确保代码质量
│
├── docs/              # 文档资料，包括用户指南和技术文档
│
├── package.json       # 主工程的npm配置文件，定义依赖和脚本命令
├── README.md          # 项目简介和快速入门指导
└── yarn.lock          # Yarn依赖锁定文件，保证环境一致性

二、项目的启动文件介绍

在lint-md项目中，启动逻辑通常不是通过一个单一的“启动文件”直接驱动应用运行，而是依赖于具体的工作流程。对于开发者或贡献者而言，关键的入口点是通过CLI执行任务，如使用@lint-md/cli包来执行Markdown文件的检查。

CLI启动方法

用户可以通过安装CLI工具并直接在命令行中使用来启动Markdown文件的检查流程：

npx @lint-md/cli your-markdown-file.md

或者，在全局安装后直接调用：

npm install -g @lint-md/cli
lint-md your-markdown-file.md

这里，“your-markdown-file.md”替换为实际要检查的Markdown文件路径。

三、项目的配置文件介绍

Lint-MD允许用户自定义配置来调整检查规则，虽然它本身没有特定命名的配置文件模板（如.lintmdrc），但用户可以通过创建一个JavaScript或JSON文件来配置规则，然后在使用CLI时指定该配置文件路径。

一个简单的配置示例（假设文件名为lint-md.config.js）：

module.exports = {
  rules: {
    'no-missing-space-atx': 'off', // 关闭ATX标题缺少空格的警告
    'line-length': { max: 80, codeBlockLineLength: 120 }, // 设置行长度限制
  },
};

使用配置文件的方式是在执行CLI命令时添加--config <path>参数：

lint-md --config path/to/your/lint-md.config.js your-markdown-file.md

以上配置和启动方法提供了一个基础框架，使开发者和文档作者能够高效地利用Lint-MD来保持Markdown文档的高质量和规范性。

lint-md:books: 检查中文 markdown 编写格式规范的命令行工具，基于 AST，方便集成 CI，写博客 / 文档必备。支持 API 调用！项目地址:https://gitcode.com/gh_mirrors/li/lint-md