構文ハイライト

GitLabは、Highlight.jsとRouge Ruby gemを介して、すべてのファイルの構文ハイライトを提供します。ほとんどの場合、これで十分ですが、ファイル拡張子に基づいて使用する言語を推測しようとします。

ここでのパスでは、Gitの.gitattributesインターフェースを使用します。

ファイルタイプの構文ハイライトをオーバーライドする

ファイルタイプの構文ハイライトをオーバーライドするには、次の手順に従います:

1. .gitattributesファイルがプロジェクトのルートディレクトリに存在しない場合は、この名前で空のファイルを作成します。

2. 変更するファイルタイプごとに、ファイル拡張子と目的の言語を宣言する行を.gitattributesファイルに追加します:

   # This extension would typically receive Perl syntax highlighting
   # but if we also use Prolog, we may want to override highlighting for
   # files with this extension:
   *.pl gitlab-language=prolog

3. 変更をコミット、プッシュ、マージしてデフォルトブランチに反映します。

変更がデフォルトブランチにマージされると、プロジェクト内のすべての*.plファイルは、選択した言語で強調表示されます。

Common Gateway Interface（CGI）オプションで、構文ハイライトを拡張することもできます（以下に例を示します）:

# JSON file with .erb in it
/my-cool-file gitlab-language=erb?parent=json

# An entire file of highlighting errors!
/other-file gitlab-language=text?token=Error

ファイルタイプの構文ハイライトを無効にする

ファイルタイプのハイライトを完全に無効にするには、ファイルタイプのハイライトをオーバーライドする手順に従い、gitlab-language=textを使用します:

# Disable syntax highlighting for this file type
*.module gitlab-language=text

ハイライトの最大ファイルサイズを構成する

デフォルトでは、GitLabは512 KBを超えるすべてのファイルをプレーンテキストで表示します。この値を変更するには、次の手順に従います:

1. プロジェクトのgitlab.yml設定ファイルを開きます。

2. このセクションを追加し、maximum_text_highlight_size_kilobytesを目的の値に置き換えます。

   gitlab:
     extra:
       ## Maximum file size for syntax highlighting
       ## https://docs.gitlab.com/ee/user/project/highlighting.html
       maximum_text_highlight_size_kilobytes: 512

3. 変更をコミット、プッシュ、マージしてデフォルトブランチに反映します。