Syntax Highlighting

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

GitLab은 Highlight.js와 루비 젬인 Rogue을 통해 모든 파일에 구문 강조 기능을 제공합니다. 대부분의 경우 파일 확장자를 기반으로 어떤 언어를 사용할지 추측을 시도하지만, 이는 대부분의 경우 충분합니다.

이곳의 경로는 Git에서 .gitattributes 인터페이스를 사용합니다.

참고: 웹 IDE와 스니펫은 텍스트 편집을 위해 Monaco Editor를 사용하며 내부적으로 구문 강조 기능을 위해 Monarch 라이브러리를 사용합니다.

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

참고: 웹 IDE에서는 .gitattribute 파일을 지원하지 않습니다.

파일 유형에 대한 구문 강조를 재정의하려면:

  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. 변경 사항을 기본 브랜치로 커밋하고 푸시한 후 합칩니다.