구문 강조

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

GitLab은 모든 파일에 대해 Highlight.js와 Rouge Ruby gem을 통해 구문 강조를 제공합니다. 그것은 대부분의 경우 파일 확장자를 기반으로 어떤 언어를 사용할지 추측합니다.

여기서 사용된 경로는 Git의 .gitattributes 인터페이스를 사용합니다.

note
Web IDE 및 Snippets은 텍스트 편집을 위해 Monaco Editor를 사용하며 내부적으로는 구문 강조를 위해 Monarch 라이브러리를 사용합니다.

파일 유형에 대한 구문 강조 재정의

파일 유형에 대한 구문 강조를 재정의하려면 다음 단계를 따르세요:

  1. 프로젝트의 루트 디렉토리에 .gitattributes 파일이 없는 경우, 이 이름의 빈 파일을 만드세요.

  2. 수정하려는 각 파일 유형에 대해, .gitattributes 파일에 파일 확장자와 원하는 구문 강조 언어를 선언하는 줄을 추가하세요: 

    # 이 확장명은 보통 Perl 구문 강조를 받지만
# 만약 Prolog도 사용한다면, 이 확장명 파일에 대한 강조를 재정의할 수 있습니다:
*.pl gitlab-language=prolog
  3. 변경 사항을 커밋하고 푸시한 후 기본 브랜치로 병합하세요.

이 변경 사항이 기본 브랜치로 병합되면 프로젝트의 모든 *.pl 파일이 원하는 언어로 강조 표시됩니다.

또한 다음과 같은 Common Gateway Interface (CGI) 옵션으로 강조 표시를 확장할 수도 있습니다: 

# .erb가 포함된 JSON 파일
/my-cool-file gitlab-language=erb?parent=json

# 강조 표시 오류가 포함된 전체 파일!
/other-file gitlab-language=text?token=Error

파일 유형에 대한 구문 강조 비활성화

파일 유형에 대해 전체 구문 강조를 비활성화하려면 파일 유형에 대한 강조를 재정의하는 지침을 따르고, gitlab-language=text를 사용하세요: 

# 이 파일 유형에 대해 구문 강조 비활성화
*.module gitlab-language=text

구문 강조의 최대 파일 크기 구성

기본적으로 GitLab은 512 KB보다 큰 파일을 일반 텍스트로 렌더링합니다. 이 값을 변경하려면:

  1. 프로젝트의 gitlab.yml 구성 파일을 엽니다.

  2. 원하는 값으로 maximum_text_highlight_size_kilobytes를 대체하여 다음 섹션을 추가하세요. 

    gitlab:
  extra:
    ## 구문 강조를 위한 최대 파일 크기
    ## https://docs.gitlab.com/ee/user/project/highlighting.html
    maximum_text_highlight_size_kilobytes: 512
  3. 변경 사항을 커밋하고 푸시한 후 기본 브랜치로 병합하세요.