markdownlint Markdown의 체크 항목을 의도적으로 OFF로 설정

목적


  • VisualStudioCode (이후 VScode)의 플러그인 인 markdownlint의 임의의 체크 항목을 OFF하는 방법을 정리한다.

    markdownlint의 체크는 도움이 되지만・・・


  • Markdown의 기재 실수를 교정해 주는 markdownlint의 기능은 훌륭하고, 간단하게 기재 실수를 발견할 수 있다.
  • 그러나 약간 기재 형식이 바짝, 자신 나름의 기재 방법을 하면 에러로서 인식되어 버리는 때가 있다.
  • 에러가 나와도 무시하면 좋지만 많은 에러의 밑줄이 표시되고 있다고 정말로 기재 미스하고 있을 때 발견되지 않는다.
  • 자신의 기재방법에 없는 것의 체크를 의도적으로 OFF로 하는 방법을 간단히 기재한다.

  • 방법


  • VScode를 시작합니다.

  • 화면 왼쪽 상단의 "code"에서 "기본 설정"→ "설정"으로 진행합니다.



  • 설정 검색란에 settings.json을 입력하여 히트한 최상위 settings.json으로 편집을 클릭합니다.



  • 열린 "settings.json"파일에 아래와 같이 OFF로 하고 싶은 에러의 에러 코드를 기재한다.

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


  • 필자는 「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
        },
    }
    

  • 설명한 순간부터 설정이 반영되어 해당 체크가 OFF가 된다.

  • 「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"
            ]
        }
    }
    

  • 좋은 웹페이지 즐겨찾기