構文のハイライト

GitLabはHighlight.jsと RougeRuby gemを通して全てのファイルのシンタックスハイライトを提供します。ファイルの拡張子から使用する言語を推測しようとしますが、ほとんどの場合それで十分です。

ここでのパスはGitの.gitattributes インターフェース 。

note
Web IDEと スニペットでは、テキスト編集にMonaco Editorを使います。MonacoEditorは内部でシンタックスハイライトにMonarchライブラリを使います。

ファイルタイプのシンタックスハイライトのオーバーライド

ファイルタイプの構文強調表示を上書きするには

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

  2. 変更したいファイル・タイプごとに、.gitattributes ファイルにファイルの拡張子と希望の強調表示言語を宣言する行を追加します：

    # This extension would normally 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は512KB以上のファイルをプレーンテキストで表示します。この値を変更するには

  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. 変更をコミットし、プッシュしてデフォルトブランチにマージします。