문법 강조

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