search
LoginSignup
12

More than 1 year has passed since last update.

posted at

updated at

【Markdown】markdownlintのconfigの設定方法

markdownlintの構文チェックが厳しい;;

なのでちょっと基準をちょっとゆるくしてみたお話。

といっても、ただ基準をtrueからfalseにしただけです笑

markdownlintの導入

ここらへん見て入れましょう!

configの設定

今回のmarkdownlintを使っている環境はVSCodeなので、その環境での設定方法を書きます。

まずはみなさんご存知のsetting.jsonを開きます。

開き方は
ctrl+comma (File -> Preferences -> Setting)で設定パネルを開いて、

image.png

をクリックです。

あとは、setting.jsonにmarkdownlintと打っている間に勝手に補完してくれます。

"markdownlint.config": {

    }

こんな感じに。なんか便利ね。

あとはゆるくしたいルールをfalseに設定するだけです。

例えば、

# Some text

## Some text

#で示すヘッダーが同じだと

MD024/no-duplicate-heading/no-duplicate-header: Multiple headings with the same contentmarkdownlint(MD024)

な感じでヘッダーが同じですよと警告してきます。

文末の(MD024)が構文チェックのルールの項目ID的なやつです。

(MD024)をfalseにすれば、そのルールに従う構文チェックが実行されなくなります。

"markdownlint.config": {
    "MD024": false
    }

こんな感じ。

ルールの設定は全てがbooleanでできるわけではないので、

公式で確認してみてください。

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
What you can do with signing up
12