开发者社区

文档建议反馈控制台

最新优惠活动

文章/答案/技术大牛

发布

社区首页 >专栏 >lint-md-cli：一款检查中文 Markdown 编写格式规范的命令行工具

lint-md-cli：一款检查中文 Markdown 编写格式规范的命令行工具

Hsinyan

发布于 2022-08-30 15:20:29

3810

发布于 2022-08-30 15:20:29

举报

文章被收录于专栏：Hsinyan写字的地方Hsinyan写字的地方

前言

在之前的文章我整理了中文 Markdown 的编写规范，但是在日常写作当中，还是避免不了出现一些不满足规范的情况，这个时候就需要一款检查工具。在 Github 上浏览的时候发现了这款 lint-md-cli 命令行工具，基本解决了我的问题。

lint-md-cli 介绍

用于检查中文 markdown 编写格式规范的命令行工具，基于 AST 开发，且方便集成 ci；同时提供 API 方法调用。其检查类型基于阮一峰的中文技术文档写作规范。

安装

 npm i -g lint-md-cli

使用

Usage: <lint-md> <files...> [options]

lint your markdown files

Options:
  -v, --version                  output the version number
  -c, --config [configure-file]  use the configure file, default .lintmdrc
  -f, --fix                      fix the errors automatically
  -h, --help                     output usage information

校验 lint

修复 fix

示例

以本篇文章为例，进行校验和修复效果如下图

回到文中可以看到不规范的地方已经自动修复了

更多使用细节请查看 Github 原项目：https://github.com/lint-md/cli

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

如有侵权请联系 cloudcommunity@tencent.com 删除

命令行工具

本文分享自作者个人站点/博客前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与腾讯云自媒体同步曝光计划，欢迎热爱写作的你一起参与！

命令行工具

评论

登录后参与评论

0 条评论

热度

最新

LV.

目录

前言
lint-md-cli 介绍
安装
使用
示例

相关产品与服务

命令行工具

腾讯云命令行工具 TCCLI 是管理腾讯云资源的统一工具。使用腾讯云命令行工具，您可以快速调用腾讯云 API 来管理您的腾讯云资源。此外，您还可以基于腾讯云的命令行工具来做自动化和脚本处理，以更多样的方式进行组合和重用。

产品介绍产品文档