使用markdownlint-cli格式化Markdown文件

简介

markdownlint是一个Markdown格式化工具，它可以对Markdown的格式进行分析，以检查是否符合规则。
markdownlint本身是一个Node.js库，没有提供CLI工具。而markdownlint-cli则为markdownlint提供了一个CLI使用方式，使markdownlint的使用更加便捷

安装

markdownlint和markdownlint-cli是Node.js程序，需要通过npm安装

1	npm install -g markdownlint-cli

使用

安装完成以后，可以提供markdownlint命令使用，例如查找除了node_modules（Node.js的依赖存储目录）以外的文件夹中的Markdown文件（静态博客可以使用这个来检查Markdown文件）

1	markdownlint */.md --ignore node_modules

如果发现了问题，会报错。如果想要markdownlint尝试自动修正，可以添加--fix参数

1	markdownlint */.md --ignore node_modules --fix

markdownlint会尝试尽可能地修正可以修正的Markdown文件
markdownlint可能会存在一些误报情况，无视即可。例如

1	source/404.md:11 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "{% p center huge, 404 %}"]

如果博客的Markdown文件存在GitHub中，可以利用GitHub Actions自动格式化Markdown文件（我是在每月1号自动格式化Markdown文件，可以修改on以在其它时间时间触发，例如推送新的提交到main分支时）：

name: Lint Markdown

on:
  workflow_dispatch:
  schedule:
    - cron: '0 0 1 * *'
  
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Install markdownlint-cli
      run: |
          npm install -g markdownlint-cli
    - name: Markdown Lint
      continue-on-error: true
      run: |
          markdownlint **/*.md --ignore node_modules --fix
    - name: Commit change & Push
      continue-on-error: true
      run: |
          git config user.name 'github-actions[bot]'
          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
          git commit -am "Markdown Lint"
          git push

推荐订阅源

codeqihan的博客

简介

安装

使用