Loading [MathJax]/jax/output/CommonHTML/config.js
前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >lint-md-cli:一款检查中文 Markdown 编写格式规范的命令行工具

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

作者头像
Hsinyan
发布于 2022-08-30 07:20:29
发布于 2022-08-30 07:20:29
49100
代码可运行
举报
运行总次数:0
代码可运行

前言

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

lint-md-cli 介绍

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

安装

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
 npm i -g lint-md-cli

使用

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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 删除。

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

评论
登录后参与评论
暂无评论
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
本文部分代码块支持一键运行,欢迎体验
本文部分代码块支持一键运行,欢迎体验