mirror of
https://github.com/redmine/redmine.git
synced 2025-12-16 05:20:28 +01:00
Updated the "Code highlighting" section in wiki help as the syntax highlighter was replaced with Rouge (#24681).
git-svn-id: http://svn.redmine.org/redmine/trunk@17536 e93f8b46-1217-0410-a6f0-8f06a7374b81
This commit is contained in:
@@ -285,7 +285,7 @@ It can be expanded by clicking a link.
|
||||
|
||||
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
||||
|
||||
<p>Default code highlightment relies on <a href="http://coderay.rubychan.de/" class="external">CodeRay</a>, a fast syntax highlighting library written completely in Ruby. It currently supports c, clojure, cpp (c++, cplusplus), css, delphi (pascal), diff (patch), erb (eruby, rhtml), go, groovy, haml, html (xhtml), java, javascript (ecmascript, ecma_script, java_script, js), json, lua, php, python, ruby (irb), sass, sql, taskpaper, text (plain, plaintext), xml and yaml (yml) languages, where the names inside parentheses are aliases.</p>
|
||||
<p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers" class="external">https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers</a> for the full list of supported languages.</p>
|
||||
|
||||
<p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
|
||||
|
||||
@@ -297,16 +297,16 @@ It can be expanded by clicking a link.
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="ruby syntaxhl"><span class="CodeRay"><span class="comment"># The Greeter class</span>
|
||||
<span class="keyword">class</span> <span class="class">Greeter</span>
|
||||
<span class="keyword">def</span> <span class="function">initialize</span>(name)
|
||||
<span class="instance-variable">@name</span> = name.capitalize
|
||||
<span class="keyword">end</span>
|
||||
<pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
|
||||
<span class="k">class</span> <span class="nc">Greeter</span>
|
||||
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
||||
<span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
<span class="keyword">def</span> <span class="function">salute</span>
|
||||
puts <span class="string"><span class="delimiter">"</span><span class="content">Hello </span><span class="inline"><span class="inline-delimiter">#{</span><span class="instance-variable">@name</span><span class="inline-delimiter">}</span></span><span class="content">!</span><span class="delimiter">"</span></span>
|
||||
<span class="keyword">end</span>
|
||||
<span class="keyword">end</span></span></code>
|
||||
</pre>
|
||||
<span class="k">def</span> <span class="nf">salute</span>
|
||||
<span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user