構文のハイライト

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

Note:WebIDEと スニペットではテキスト編集にMonaco Editorを使用しており、内部でシンタックスハイライトにMonarchライブラリを使用しています。

もしGitLabが間違った推測をした場合は、.gitattributesgitlab-language 属性を使って言語の選択を上書きすることができます。例えば、Prologプロジェクトで作業をしていて、.pl ファイル拡張子(通常はPerlとしてハイライトされます)を使っている場合は、.gitattributes ファイルに次のように追加します:

*.pl gitlab-language=prolog

チェックインして、その変更をプッシュすると、プロジェクト内のすべての*.pl ファイルがPrologとしてハイライトされます。

ここでのパスは、単にGitの組み込みの.gitattributes インターフェイス。ですから、もしプロジェクトのルートでRuby構文を使うNicefile というファイルフォーマットを発明するとしたら、必要なのはそれだけです:

/Nicefile gitlab-language=ruby

ハイライトを完全に無効にするには、gitlab-language=textを使ってください。 CGI のオプションには、次のような楽しいいたずらもあります:

# json 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

これらの設定は、.gitattributes ファイルがデフォルトブランチ (通常はmaster) にある場合にのみ有効になることに注意してください。

注:Web IDE は.gitattribute ファイルをサポートしていませんが、将来のリリースでサポートする予定です。