markdownlint의 구문 검사가 엄격하다;;

그래서 조금 기준을 조금 느슨하게 해 본 이야기.

그럼에도 불구하고 표준을 true에서 false로 만들었습니다.

markdownlint 도입

Visual Studio Code로 Markdown 편집 환경 설정

Markdown 파일을 구문 검사하는 방법

여기 좀 봐요!

config 설정

이번 markdownlint를 사용하고 있는 환경은 VSCode이므로, 그 환경에서의 설정 방법을 씁니다.

우선 여러분 아시는 setting.json을 엽니다.

여는 방법은
ctrl+comma (File -> Preferences -> Setting)에서 설정 패널을 열고,



을 클릭합니다.

그리고는, 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으로 할 수 있는 것은 아니기 때문에,

공식으로 확인해보십시오.

markdownlint 규칙 목록