markdownlint Markdownのチェック項目を意図的にOFFにする

目的

• VisualStudioCode（以降VScode）のプラグインであるmarkdownlintの任意のチェック項目をOFFにする方法をまとめる

markdownlintのチェックは助かるけど・・・

• Markdownの記載ミスを校正してくれるmarkdownlintの機能は素晴らしく、簡単に記載ミスを発見する事ができる。
• しかし若干記載フォーマットがきつく、自分なりの記載方法をするとエラーとして認識されてしまう時がある。
• エラーが出ていても無視すればよいが沢山エラーの下線が表示されていると本当に記載ミスしている時に見つけられない。
• 自分の記載方法にあっていないもののチェックを意図的にOFFにする方法を簡単に記載する。

方法

1. VScodeを起動する。

2. 画面左上の「code」から「基本設定」 → 「設定」と進む。

   

3. 設定の検索欄に「settings.json」と入力してヒットした最上位の「settings.jsonで編集」をクリックする。

   

4. 開いた「settings.json」ファイルに下記のようにOFFにしたいエラーのエラーコードを記載する。

   settings.json

   {
       "markdownlint.config": {
           "OFFにしたいエラーのエラーコード": false,
       }
   }
   

5. 筆者は「MD025」「MD014」「MD010」「MD009」「MD007」「MD031」「MD040」をOFFとして設定しているので下記のように記載されている。

   settings.json

   {
       "markdownlint.config": {
           "MD025": false,
           "MD014": false,
           "MD010": false,
           "MD009": false,
           "MD007": false,
           "MD031": false,
           "MD040": false
       },
   }
   

6. 記載した瞬間から設定が反映されて当該のチェックがOFFになる。

7. 「settings.json」の記載例として筆者の「settings.json」の内容を下記に記載する。今回の記事に関係ない設定も記載されている。

   settings.json

   {
       "terminal.integrated.shell.osx": "/bin/bash",
       "files.autoSave": "afterDelay",
       "editor.minimap.enabled": false,
       "terminal.integrated.scrollback": 1e+100,
       "workbench.startupEditor": "newUntitledFile",
       "liveServer.settings.donotShowInfoMsg": true,
       "editor.accessibilitySupport": "on",
       "debug.allowBreakpointsEverywhere": true,
       "markdown.extension.katex.macros": {
       
       },
       "markdownlint.config": {
   
           "MD025": false,
           "MD014": false,
           "MD010": false,
           "MD009": false,
           "MD007": false,
           "MD031": false,
           "MD040": false
       },
       "bracket-pair-colorizer-2.activeScopeCSS": [
   
           "borderStyle : solid",
           "borderWidth : 1px",
           "borderColor : {color}",
           "opacity: 0.5"
       ],
       "bracket-pair-colorizer-2.colors": [
   
           "Gold",
           "Orchid",
           "LightSkyBlue"
       ],
       "workbench.iconTheme": "vscode-icons",
       "mssql.connections": [
           {
               "server": "{{put-server-name-here}}",
               "database": "{{put-database-name-here}}",
               "user": "{{put-username-here}}",
               "password": "{{put-password-here}}"
           }
       ],
       "[json]": {
       
           "editor.quickSuggestions": {
               "strings": true
           },
           "editor.suggest.insertMode": "replace",
           "gitlens.codeLens.scopes": [
               "document"
           ]
       }
   }