markdownlint 문서 테스트

GitLab 문서에서 markdownlint를 설치, 구성, 실행하고 테스트를 비활성화하는 방법을 설명합니다.

markdownlint 는 Markdown 구문이 특정 규칙 을 따르는지 검사하며, docs-lint 테스트에서 사용됩니다. 문서 스타일 가이드 와 Markdown 가이드 에서는 GitLab 문서에 사용할 Markdown 구문을 선택할 때 어떤 선택을 해야 하는지 상세히 설명합니다. 이 도구는 해당 지침으로부터의 이탈을 잡아내는 데 도움이 됩니다. markdownlint 설정은 다음 프로젝트에서 찾을 수 있습니다: gitlab gitlab-runner omnibus-gitlab charts gitlab-development-kit gitlab-operator cli 이 설정은 빌드 파이프라인에서도 사용됩니다. markdownlint는 다음과 같은 방법으로 사용할 수 있습니다: 커맨드라인에서 다음 중 하나를 사용: markdownlint-cli . markdownlint-cli2 . 코드 에디터에서 . pre-push 훅에서 . markdownlint 설치 # markdownlint 를 실행하려면 markdownlint-cli 또는 markdownlint-cli2 중 하나를 설치할 수 있습니다. markdownlint-cli 를 설치하려면 다음을 실행하세요: yarn global add markdownlint-cli markdownlint-cli2 를 설치하려면: mise 를 사용하는 경우, 다음을 실행하세요: mise use -g markdownlint-cli2 yarn 을 사용하는 경우, 다음을 실행하세요: yarn global add markdownlint-cli2 GitLab Docs 프로젝트에서 사용하는 버전과 일치하는 markdownlint-cli 또는 markdownlint-cli2 버전을 설치해야 합니다. 올바른 버전은 variables: 섹션 에서 확인할 수 있습니다. 에디터에서 markdownlint 구성 # 에디터에서 markdownlint를 사용하면 커맨드라인에서 명령어를 실행하는 것보다 더 편리합니다. 에디터에서 markdownlint를 구성하려면 다음 중 적절한 것을 설치하세요: Visual Studio Code DavidAnson.vscode-markdownlint 확장 . Sublime Text SublimeLinter-contrib-markdownlint 패키지 . 이 패키지는 기본적으로 markdownlint-cli 를 사용하지만, 다음 SublimeLinter 설정으로 markdownlint-cli2 를 사용하도록 구성할 수 있습니다: "markdownlint": { "executable": [ "markdownlint-cli2" ] } Vim ALE 플러그인 . Emacs Flycheck 확장 . Flycheck 는 기본적으로 markdownlint-cli 를 지원하지만, 프로젝트 디렉터리의 루트에 있는 .markdownlint.yml 을 가리키도록 .dir-locals.el 파일을 추가해야 합니다: ;; Place this code in a file called `.dir-locals.el` at th