diff options
| author | Sytse Sijbrandij <sytse@gitlab.com> | 2016-01-25 21:49:21 +0000 |
|---|---|---|
| committer | Sytse Sijbrandij <sytse@gitlab.com> | 2016-01-25 21:49:21 +0000 |
| commit | 44275041c801af0a769284d3cc3a50b20752bb90 (patch) | |
| tree | 40f7b05274c944707551cdf073da3f9f3ccc690c | |
| parent | 991cd07619a4072e35073f1eaf4c8661871e66bb (diff) | |
| parent | 6292ddd1980cad80e0f8385929cb07767b604efb (diff) | |
| download | gitlab-ce-44275041c801af0a769284d3cc3a50b20752bb90.tar.gz | |
Merge branch 'mention_rouge_in_docs' into 'master'
Add references to the rouge gem library
Give the props to this awesome library we use
for syntax highlighting.
See merge request !2605
| -rw-r--r-- | doc/markdown/markdown.md | 5 | ||||
| -rw-r--r-- | doc/profile/preferences.md | 5 |
2 files changed, 10 insertions, 0 deletions
diff --git a/doc/markdown/markdown.md b/doc/markdown/markdown.md index bc8e7d155e7..83c77742b19 100644 --- a/doc/markdown/markdown.md +++ b/doc/markdown/markdown.md @@ -88,6 +88,9 @@ GFM will autolink almost any URL you copy and paste into your text. ## Code and Syntax Highlighting +_GitLab uses the [rouge ruby library][rouge] for syntax highlighting. For a +list of supported languages visit the rouge website._ + Blocks of code are either fenced by lines with three back-ticks <code>```</code>, or are indented with four spaces. Only the fenced code blocks support syntax highlighting. ```no-highlight @@ -585,3 +588,5 @@ By including colons in the header row, you can align the text within that column - This document leveraged heavily from the [Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). - The [Markdown Syntax Guide](https://daringfireball.net/projects/markdown/syntax) at Daring Fireball is an excellent resource for a detailed explanation of standard markdown. - [Dillinger.io](http://dillinger.io) is a handy tool for testing standard markdown. + +[rouge]: http://rouge.jneen.net/ "Rouge website" diff --git a/doc/profile/preferences.md b/doc/profile/preferences.md index f17bbe8f2aa..073b8797508 100644 --- a/doc/profile/preferences.md +++ b/doc/profile/preferences.md @@ -12,6 +12,9 @@ The default is **Charcoal**. ## Syntax highlighting theme +_GitLab uses the [rouge ruby library][rouge] for syntax highlighting. For a +list of supported languages visit the rouge website._ + Changing this setting allows the user to customize the theme used when viewing syntax highlighted code on the site. @@ -36,3 +39,5 @@ The default is **Your Projects**. It allows user to choose what content he or she want to see on project page. The default is **Readme**. + +[rouge]: http://rouge.jneen.net/ "Rouge website" |