Qiita Teams that are logged in
You are not logged in to any team

Log in to Qiita Team
Community
OrganizationAdvent CalendarQiitadon (β)
Service
Qiita JobsQiita ZineQiita Blog
6
Help us understand the problem. What is going on with this article?
@kkkrikurikun

【Markdown】markdownlintのconfigの設定方法

More than 1 year has passed since last update.

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でできるわけではないので、

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

6
Help us understand the problem. What is going on with this article?
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away

Comments

No comments
Sign up for free and join this conversation.
Sign Up
If you already have a Qiita account Login
6
Help us understand the problem. What is going on with this article?