유연한 문법과 일관성
Markdown은 같은 결과를 여러 표기 방식으로 작성할 수 있다. 이런 유연성 때문에 문서마다 제목이나 공백 사용이 달라지기도 한다. Markdownlint는 정적 분석 규칙으로 작성 형식의 차이와 문제를 진단한다. 글의 사실관계나 내용의 완성도를 평가하는 도구는 아니다.
어떤 부분을 검사하는가
제목 단계가 갑자기 건너뛰는지, 줄 끝 공백과 빈 줄이 일정한지 등을 검사한다. 링크의 형태와 코드 블록의 언어 지정, 이미지 대체 텍스트 같은 항목도 규칙에 포함된다. 각 규칙은 식별자를 가지므로 검사 결과를 어떤 작성 기준과 연결할지 알 수 있다.
라이브러리와 사용 환경
Micromark로 문서를 분석하고 CommonMark를 따르며 표와 자동 링크 등 GitHub Flavored Markdown 기능도 지원한다. Node.js 라이브러리와 별도의 명령행 인터페이스를 구분할 수 있다. 편집기 확장이나 개발 도구에 연결해 작성 중 또는 변경 사항 검사 과정에서 사용할 수 있다.
관련 문서
Vale 문서 검사기 / Semgrep / ShellCheck / 마크다운