Markdown Linter

검사 내용

markdownlint 전체 규칙을 적용합니다. 주요 내용:

• MD001 — 제목 레벨은 한 번에 1단계씩만 증가
• MD009 — 줄 끝에 공백을 두지 않음
• MD010 — 하드 탭 사용 금지 (공백 사용)
• MD012 — 연속 빈 줄을 여러 개 두지 않음
• MD022 — 제목 앞뒤에 빈 줄 삽입
• MD025 — 문서 내 최상위 제목은 하나만
• MD031 — 코드 펜스 앞뒤에 빈 줄 삽입
• MD034 — 노출된 URL 사용 금지, 링크 문법 사용
• MD041 — 첫 줄은 최상위 제목이어야 함

개인정보

모든 처리는 클라이언트에서 이루어집니다. Markdown 내용은 업로드되거나 저장되지 않습니다.

관련 도구

• Markdown 미리보기 — Markdown을 HTML로 실시간 렌더링
• Markdown 표 생성기 — 시각적으로 표를 작성

예시: CHANGELOG

입력:

# Changelog

## 1.2.0

### Added

- Export button

## 1.1.0

### Added

* Dark mode

See https://example.com/releases

결과(markdownlint 0.40, 기본 규칙):

L13  MD004 / ul-style            Unordered list style — Expected: dash; Actual: asterisk
L11  MD024 / no-duplicate-heading Multiple headings with the same content
L15  MD034 / no-bare-urls         Bare URL used

• 두 버전 모두에 「Added」 제목이 있어 MD024가 발생합니다. Keep a Changelog의 표준 형식이므로, 자신의 설정에서는 "MD024": { "siblings_only": true }로 부모가 다른 같은 제목을 허용합니다.
• MD004는 문서 안에서 목록 기호를 하나로 통일하라고 요구합니다. 첫 목록이 -를 썼으므로 *가 지적됩니다.
• MD034는 맨 URL을 <https://example.com/releases>나 Markdown 링크로 쓰라고 요구합니다.

여기서 바꿀 수 없는 기본값

도구는 markdownlint가 기본으로 켜 둔 모든 규칙을 기본 설정으로 실행합니다(markdownlint rules 참고). 설정 화면이 없어서 다음 두 가지가 자주 불필요한 지적이 됩니다:

• MD013 줄 길이는 80자입니다. 104자짜리 영어 문장 줄은 Expected: 80; Actual: 104로 보고됩니다. 80열 이후에 공백이 없는 긴 줄은 보고되지 않지만, 한국어는 띄어쓰기를 하므로 긴 한국어 줄은 보통 보고됩니다.
• MD024는 문서에서 같은 제목 문자열이 반복되면 지적합니다. 위의 CHANGELOG가 그 예입니다.

자신의 설정으로 검사하려면 .markdownlint.json에 쓰고 로컬이나 CI에서 markdownlint-cli2를 실행하세요:

{
"MD013": { "line_length": 120 },
"MD024": { "siblings_only": true }
}

markdownlint는 파일 맨 앞의 YAML front matter를 건너뛰며, 그 안의 title은 MD041에서 최상위 제목으로 취급됩니다.