Loading [MathJax]/jax/output/CommonHTML/config.js

开发者社区

文档建议反馈控制台

文章/答案/技术大牛

发布

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

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

Hsinyan

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

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

49100

代码可运行

举报

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

运行总次数：0

代码可运行

前言

在之前的文章我整理了中文 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 删除。

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

命令行工具

评论

登录后参与评论

暂无评论

编辑精选文章

换一批

万字详解高可用架构设计

Go 开发者必备：Protocol Buffers 入门指南

10分钟带你彻底搞懂分布式链路跟踪

手摸手教你撸一个代码检测命令行工具(CLI)

npm eslint git github 开源

大家在做前端开发的时候，为了保证团队成员提交代码的质量，一般都会对代码进行代码质量检查和代码美化工作，通常的做法是进行一系列的配置，借助于 eslint、prettier、lint-staged、husky 等工具实现代码的检测工作。但是这个过程涉及众多，配置起来也很繁琐，而且针对不同的项目都需要进行重复配置，无疑增加了大家的工作量，那么我要解决的就是这个问题，提供一个命令行工具来封装上述检测工具，简化配置步骤。

astonishqft

2022/05/10

1.4K0

手摸手教你撸一个代码检测命令行工具(CLI)

5个基本Linux命令行工具的现代化替代品

grep https json 网络安全 linux

在日常使用 Linux/Unix 系统时，我们会使用许多命令行工具来完成我们的工作，并理解和管理我们的系统，像 du 用于监视磁盘利用率，top 用于显示系统资源。其中一些工具已经存在很长时间了。例如，top 于 1984 年首次发布，而 du 的首次发布要追溯到 1971 年。

用户2781897

2020/07/22

1.2K0

5个基本Linux命令行工具的现代化替代品

基于区块开发（二）：命令行工具

命令行工具 ide 编程算法

在上一篇文章中，我简单的介绍了基于区块开发的总体思路和配套工具。接下来我会用 2 篇文章来分别介绍命令行工具和VSCode插件的具体实现细节。

Dickensl

2022/06/14

5440

基于区块开发（二）：命令行工具

Android代码静态检查（lint、Checkstyle、ktlint、Detekt）

html android 检测工具 java kotlin

在Android项目开发过程中，开发团队往往要花费大量的时间和精力发现并修改代码缺陷。

静默加载

2022/12/27

2.1K0

Android代码静态检查（lint、Checkstyle、ktlint、Detekt）

node命令行工具之实现项目工程自动初始化的标准流程

npm node.js javascript 命令行工具

可以看出，传统的初始化步骤，花费的时间并不少。而且，人工操作的情况下，总有改漏的情况出现。这个缺点有时很致命。甚至有马大哈，没有更新项目仓库地址，导致提交代码到旧仓库，这就很尴尬了。。。基于这些情况，编写命令行工具（CLI）的目的就很明确：

我是leon

2019/08/28

8110

node命令行工具之实现项目工程自动初始化的标准流程

【干货】打造自己的web前端工作流（一）--- 交互的命令行工具模板篇

前言 web前端领域技术日新月异，技术栈也不断丰富，在日常工作中涉及到的内容也不断增加，一个前端项目从开发到发布涉及的步骤也很多，很多重复工作内容，因此我们需要开发一些工作来减少这些工作量---工作流。工作流现在也存在很多解决方案，大都是采用GUI方式+自定义脚本方式，相比GUI的方式很多人更爱命令行的的方式，轻量化，可以方便自定义开发，更好适应现有业务的情况。本文章目的，基于一个命令行模板工具，循序渐进的告诉读者，开发一个命令行工具，会用到哪些现有的轮子，如何让你的工具变得丰满起来。同时我也会简要

腾讯NEXT学位

2018/12/04

2.9K0

【干货】打造自己的web前端工作流（一）--- 交互的命令行工具模板篇

5 款新型 Linux 命令行工具，实用！

网络安全 https grep json 命令行工具

点击关注公众号，Java干货及时送达使用新的替代工具来改进旧的命令行工具。在Linux/Unix系统的日常使用中，我们需要使用很多命令行工具来完成工作，以及理解和管理我们的系统，例如使用du来监视磁盘利用率、top来显示系统资源。有些工具已经有很长的历史了。例如，top于1984年首次发布，而du的首次问世可追溯至1971年。多年来，这些工具已经过现代化的改造，并移植到了不同的系统中，但总的来说，它们仍然保留了最初的想法、外观和感觉。这些工具都非常优秀，对于许多系统管理员的工作流程来说都是必不可少

Java技术栈

2022/03/03

1.2K0

各种数据库命令行工具 mycli litecli mssql-cli pgcli

https 网络安全 github git 开源

mycli 是基于MySQL的命令行工具，直接使用pip install mycli 安装, 具体介绍见 https://github.com/dbcli/mycli

苏生不惑

2019/08/17

1.2K0

GitHub趋势榜第一：超级命令行工具Semantic，比较解析源代码

编程算法 github git 开源命令行工具

作为开发者，你是否对不同源代码段之间的解析和比较困惑不已呢？今天的GitHub趋势热榜上排名第一的帖子介绍了一款多语言支持的“超级命令行工具”Semantic，或许可以解决这个令人头疼的问题。

新智元

2019/06/05

8850

GitHub趋势榜第一：超级命令行工具Semantic，比较解析源代码

前端规范指南，让团队代码如出一辙！ESLint + Prettier + husky + lint-staged

eslint lint prettier 配置前端

假如团队中的小伙伴在提交代码时没有遵循规范要求，例如只写了一个"修改"或"更新，这会给团队中其他小伙伴造成困扰呢，不得不花时间查看代码和推测逻辑。

程序员王天

2023/10/18

3K0

前端规范指南，让团队代码如出一辙！ESLint + Prettier + husky + lint-staged

ROS2编程基础课程--命令行工具

node.js 命令行工具 https 编程算法网络安全

版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

zhangrelay

2019/09/19

7680

Python 命令行神器 Click

jquery flask 命令行工具 shell python

实际上 Python 标准库提供了一个默认的命令行工具 Argparse，但是对于 Click 来说 Argparse 使用起来非常的繁琐和麻烦，大多数人都很少使用它。Argparse 对比与 Click 就像网页解析中使用的 re 和 BeautifulSoup。

keinYe

2019/10/30

8890

Cobra 库上手—自建命令行工具

工具函数开发命令行命令行工具

Cobra 是一个流行的 Go 语言库，用于创建强大且灵活的命令行应用程序。它由 spf13 开发，设计用于与 Go 生态系统中的其他流行库（如 Viper 配置库）无缝集成。Cobra 支持多级命令结构，允许定义根命令和任意数量的子命令，还可以轻松处理全局和本地标志。它自动生成帮助和使用信息，并支持 Bash、Zsh、Fish 和 PowerShell 的命令补全。此外，Cobra 能够生成 Markdown 格式的文档，使文档维护更加便捷。通过与 Viper 集成，Cobra 能处理配置文件和环境变量，为开发者提供了强大的工具集，使创建复杂的 Client 工具变得简单高效。Cobra 广泛应用于各种 Go 项目中，提升了 Client 应用的开发体验和维护效率。

FunTester

2025/01/23

1830

Cobra 库上手—自建命令行工具

『如何构建命令行工具：YiYi』

封面.png 大家好，我是谢伟，是一名程序员。过去一阵子，我在开发一款客户端命令行工具，业余时间，开始写了下面这个工具。仅做学习参考使用。现在它看上去不够优雅，命令的命名也没有好好推敲。但功能都已实现。即如何构建一个命令行工具，希望通过这个项目的示例，你能开发出各种各样符合你需求的命令行工具。比如 github 上非常热门的命令行项目： annie 下载视频和图片工具 hub 一个包装git 操作github 的工具 jfrog-cli-go 一个仓库管理平台的客户端 ... 开始之前，还是看几

谢伟

2018/06/06

7620

使用 Node，如何制作一个专业的命令行工具？

node.js javascript markdown 命令行工具

大家好，我是山月，最近做了一款小命令行工具 markdown，借机分享下在 Node 中如何制作一个命令行工具。

童欧巴

2021/08/20

1.9K0

使用 Node，如何制作一个专业的命令行工具？

GitHub CLI 命令行工具使用

http github https git 开源

GitHub 被巨软收购以后推出了一系列非常好用的开发者工具，今天我们要为大家介绍的是近来 GitHub 发布的又一个非常有用的工具: GitHub CLI，可以让开发者通过命令行与 GitHub 进行无缝的协同工作，也就是我们直接在命令行终端上就可以进行 pull requests、issues 等其他功能，现在已经发布 Beta 版本，我们可以在 macOS、Windows 或者 Linux 平台上安装 GitHub CLI。

我是阳明

2020/06/15

4.4K0

GitHub CLI 命令行工具使用

腾讯云命令行工具：qcloudcli 、tccli

官网统一了国际化名称，用tencentcloud替代了qcloud，api的命令行工具现在是tccli

Windows技术交流

2020/05/15

2.6K0

一个小时学会用 Go 创建命令行工具

java python go arm64 cli

最近因为项目需要写了一段时间的 Go ，相对于 Java 来说语法简单同时又有着一些 Python 之类的语法糖，让人大呼”真香“。

crossoverJie

2022/10/27

3120

一个小时学会用 Go 创建命令行工具

Golang开发命令行工具之flag包的使用

go git 命令行工具

日常命令行操作，相对应的众多命令行工具是提高生产力的必备工具，我在之前的文章我的生产力工具推荐-终端01篇中有推荐过一些我常用的基于terminal终端的命令行cli工具

仙人技术

2021/10/13

8940

让你如“老”绅士般编写 Python 命令行工具的开源项目：docopt

github git 开源

在第一篇“初探 docopt”的文章中，我们初步掌握了使用 docopt 的三个步骤，了解了它不同于 argparse 的设计思路。那么 docopt 的使用模式都有哪些呢？其接口描述中都支持哪些语法规则呢？本文将带你深入了解 docopt。

HelloGitHub

2021/05/14

7440

相关推荐

手摸手教你撸一个代码检测命令行工具(CLI)

更多 >

LV.1

这个人很懒，什么都没有留下～

作者相关精选

换一批

目录

前言

lint-md-cli 介绍

安装

使用

示例

加入讨论

的问答专区 >

1先锋会员擅长2个领域

相关课程

一站式学习中心 >

微信小程序直播电商开发实践_《锋巢直播》

Serverless 容器服务

云数据库 SQL Server

小程序·云直播

即时通信 IM

EMR离线数仓建设实战营

弹性 MapReduce

大数据解决方案

本文部分代码块支持一键运行，欢迎体验

本文部分代码块支持一键运行，欢迎体验