はじめに

マークダウンファイルを作成する際に、記載ミス等を自動で指摘して欲しいと思い、Markdownlintの設定を行おうと思いました。

Markdownlintの設定

VSCodeの拡張機能から、markdownlintと検索します。 検索した結果から、右下のインストールを選択します。

※今回の画像は既にインストールしているため、インストールボタンが表示されていません。

インストールが完了したら、新規ファイルで.mdファイルを作成してみましょう。

インストールが正しく完了していたら、文法的におかしい部分の指摘をしてくれるようになっているはずです。

設定項目の一覧

2020年06月現在、下記のようなルールが実装されている。

lintの設定

markdownlintを使用していく上で、指摘して欲しくない部分も指摘される事が有るかと思います。
その際は、チェックのルールを変更して、指摘されないようにする事ができます。

VSCodeの設定変更方法

設定の画面で、markdownlintと検索して、settings.jsonで編集というボタンをクリックします。

クリックすると、settings.jsonが開き、下記のような内容が表示されていると思います。
その中に設定項目を記載します。

  "markdownlint.config": {
    |ここに設定を記載する
  }

  "markdownlint.config": {
    "single-h1": false
  }

上記の設定を記載し、保存する事で、markdownlintの設定が反映され、文法チェックも変更したルールに則って行われます。

さいごに

今回も、VSCodeでMarkdownを扱う際の便利機能についてまとめてみました。 まだ、設定していない人は、是非設定してみてください😁