문법 강조

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. 변경 사항을 기본 브랜치로 커밋, 푸시 및 Merge합니다.

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

또한 다음과 같은 공통 게이트웨이 인터페이스 (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. 변경 사항을 기본 브랜치로 커밋, 푸시 및 Merge합니다.