Author

Web系ソフトウェアエンジニアを志望
開発記録や個人的な技術に対する思いを綴ります

FOCUS個人開発/設計
OSArch Linux+Omarchy
STACKTypeScript・Next.js
STATUS学習中 → 就活中

markdownlintのルールを無効化・カスタムする方法

tech

markdownlintとは?

markdownlint

makrdownの正しい書き方(?)を注意してくれるプラグイン しかし、「必要かな?」と思うルールもあり使ってるうちにいくつか無効化したくなってくる。

ただ問題は、リポジトリにルールのカスタム・無効化方法が書いてないって点

カスタム・無効化方法

1. 任意のディレクトリに.markdownlint-cli2.yamlを作成する

今回は~/.config/makrdownlint/に作成。 各種ルールに関してはDavidAnson/markdonwlintを参照

# MD013を無効化する
config:
    MD013: false

2. nvim/lua/plugins/lint.luaを作成する

※ ファイル名は何でもいい

  return {
    {
      ,
      opts = {
        linters = {
          ["markdownlint-cli2"] = {
            args = {
              "--config",
              os.getenv("HOME") .. "/.config/markdownlint/.markdownlint-cli2.yaml",
              "--",
            },
          },
        },
      },
    },
  }

ここまでやってNeoVimを再起動したら完了!

ソース

  1. .markdown-cli2.yaml : LazyExtras markdown; How to configure markdownlint-cli2?
  2. lint.lua : Feature request: global config

終わりに

ここで30分くらい格闘してました。 どなたかの役に立てば幸いです。