Markdown 린트
많은 편집기와 CI 파이프라인에서 사용하는 린터인 markdownlint로 Markdown의 스타일 및 구문 문제를 확인합니다. 문서를 붙여 넣으면 MD001 같은 규칙과 설명, 문제가 있는 줄을 모두 확인할 수 있습니다. 선택적으로 markdownlint가 빈 줄, 목록 표식, 간격 등을 수정한 결과도 받을 수 있습니다.
자주 묻는 질문
어떤 규칙을 확인하나요?
제목 수준을 한 단계씩 높이는 MD001부터 목록, 빈 줄, 코드 블록, 링크, 강조 관련 규칙까지 markdownlint의 기본 활성화 규칙을 모두 확인합니다. 최대 줄 길이를 설정하지 않으면 줄 길이 규칙 MD013은 꺼져 있습니다.
규칙을 끄려면 어떻게 하나요?
비활성화할 규칙 입력란에 쉼표나 공백으로 구분해 MD033 같은 번호 또는 no-inline-html 같은 이름을 입력하세요. <!-- markdownlint-disable MD033 --> 같은 문서 안의 주석도 작동합니다.
수정 옵션은 어떤 기능을 하나요?
제목과 목록 주변에 빈 줄 추가하기, 목록 표식 통일하기, 뒤쪽 공백 제거하기 등 markdownlint가 제공하는 자동 수정을 적용하고 수정된 문서를 보여 줍니다. 자동 수정이 없는 문제는 직접 해결해야 합니다.
어떤 markdownlint 버전을 사용하나요?
markdownlint 0.42.0을 사용합니다. 이 라이브러리를 기반으로 Visual Studio Code용 markdownlint 확장 프로그램과 markdownlint-cli2가 만들어졌습니다. 같은 버전과 기본 설정을 사용하면 동일한 문제를 보고합니다.
첫 번째 제목에 문제가 있다고 나오는 이유는 무엇인가요?
규칙 MD041은 문서가 최상위 제목으로 시작하도록 요구하고, MD025는 최상위 제목을 하나만 허용합니다. 플랫폼에서 제목을 자동으로 추가한다면 문서에서 이 규칙을 비활성화하세요.
문제를 몇 개까지 표시하나요?
전체 문제 수는 항상 표시하고, 처음 500개 문제는 표에 나열합니다. 처음 몇 가지를 수정하고 다시 검사하면 나머지 문제를 확인할 수 있습니다.