-
Notifications
You must be signed in to change notification settings - Fork 1
/
file.README.html
357 lines (267 loc) · 24.2 KB
/
file.README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: README
— Documentation by YARD 0.9.28
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "README";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="file_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> »
<span class="title">File: README</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'><h1 id="rouge">Rouge</h1>
<p><img src="https://github.com/rouge-ruby/rouge/actions/workflows/ruby.yml/badge.svg" alt="Build Status">
<a href="https://rubygems.org/gems/rouge"><img src="https://badge.fury.io/rb/rouge.svg" alt="Gem Version"></a>
<a href="https://rouge-ruby.github.io/docs/"><img src="http://img.shields.io/badge/yard-docs-blue.svg" alt="YARD Docs"></a></p>
<p><a href="http://rouge.jneen.net/" title="Rouge">Rouge</a> is a pure Ruby syntax highlighter. It can highlight
<a href="https://rouge-ruby.github.io/docs/file.Languages.html" title="Languages">over 200 different languages</a>, and output HTML
or ANSI 256-color text. Its HTML output is compatible with
stylesheets designed for <a href="http://pygments.org" title="Pygments">Pygments</a>.</p>
<h2 id="installation">Installation</h2>
<p>In your Gemfile, add:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rouge</span><span class='tstring_end'>'</span></span>
</code></pre>
<p>or</p>
<pre class="code sh"><code class="sh">gem install rouge
</code></pre>
<h2 id="usage">Usage</h2>
<p>Rouge's most common uses are as a Ruby library, as part of Jekyll and as a
command line tool.</p>
<h3 id="library">Library</h3>
<p>Here's a quick example of using Rouge as you would any other regular Ruby
library:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rouge</span><span class='tstring_end'>'</span></span>
<span class='comment'># make some nice lexed html
</span><span class='id identifier rubyid_source'>source</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/etc/bashrc</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_formatter'>formatter</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Rouge.html" title="Rouge (module)">Rouge</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rouge/Formatters.html" title="Rouge::Formatters (module)">Formatters</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rouge/Formatters/HTML.html" title="Rouge::Formatters::HTML (class)">HTML</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Rouge/Formatter.html#initialize-instance_method" title="Rouge::Formatter#initialize (method)">new</a></span></span>
<span class='id identifier rubyid_lexer'>lexer</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Rouge.html" title="Rouge (module)">Rouge</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rouge/Lexers.html" title="Rouge::Lexers (module)">Lexers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rouge/Lexers/Shell.html" title="Rouge::Lexers::Shell (class)">Shell</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Rouge/Lexer.html#initialize-instance_method" title="Rouge::Lexer#initialize (method)">new</a></span></span>
<span class='id identifier rubyid_formatter'>formatter</span><span class='period'>.</span><span class='id identifier rubyid_format'>format</span><span class='lparen'>(</span><span class='id identifier rubyid_lexer'>lexer</span><span class='period'>.</span><span class='id identifier rubyid_lex'>lex</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='comment'># Get some CSS
</span><span class='const'><span class='object_link'><a href="Rouge.html" title="Rouge (module)">Rouge</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rouge/Themes.html" title="Rouge::Themes (module)">Themes</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rouge/Themes/Base16.html" title="Rouge::Themes::Base16 (class)">Base16</a></span></span><span class='period'>.</span><span class='id identifier rubyid_mode'><span class='object_link'><a href="Rouge/HasModes.html#mode-instance_method" title="Rouge::HasModes#mode (method)">mode</a></span></span><span class='lparen'>(</span><span class='symbol'>:light</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='label'>scope:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.highlight</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='comment'># Or use Theme#find with string input
</span><span class='const'><span class='object_link'><a href="Rouge.html" title="Rouge (module)">Rouge</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rouge/Theme.html" title="Rouge::Theme (class)">Theme</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find'><span class='object_link'><a href="Rouge/Theme.html#find-class_method" title="Rouge::Theme.find (method)">find</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>base16.light</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='label'>scope:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.highlight</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
</code></pre>
<h3 id="jekyll">Jekyll</h3>
<p>Rouge is Jekyll's default syntax highlighter. Out of the box, Rouge will be
used to highlight text wrapped in the <code>{% highlight %}</code> template tags. The
<code>{% highlight %}</code> tag provides minimal options: you can specify the language to
use and whether to enable line numbers or not. More information is available in
<a href="https://jekyllrb.com/docs/liquid/tags/#code-snippet-highlighting" title="Code snippet highlighting in the Jekyll documentation">the Jekyll docs</a>.</p>
<h3 id="command-line">Command Line</h3>
<p>Rouge ships with a <code>rougify</code> command which allows you to easily highlight files
in your terminal:</p>
<pre class="code sh"><code class="sh">rougify foo.rb
rougify style monokai.sublime > syntax.css
</code></pre>
<h2 id="configuration">Configuration</h2>
<h3 id="formatters">Formatters</h3>
<p>Rouge comes with a number of formatters built-in but as of Rouge 2.0, you are
encouraged to write your own formatter if you need something custom.</p>
<p>The built-in formatters are:</p>
<ul>
<li><p><code>Rouge::Formatters::HTML.new</code> will render your code with standard class names
for tokens, with no div-wrapping or other bells or whistles.</p></li>
<li><p><code>Rouge::Formatters::HTMLInline.new(theme)</code> will render your code with no class
names, but instead inline the styling options into the <code>style=</code> attribute.
This is good for emails and other systems where CSS support is minimal.</p></li>
<li><p><code>Rouge::Formatters::HTMLLinewise.new(formatter, class: 'line-%i')</code> will split
your code into lines, each contained in its own div. The <code>class</code> option will
be used to add a class name to the div, given the line number.</p></li>
<li><p><code>Rouge::Formatters::HTMLLineHighlighter.new(formatter, highlight_lines: [3, 5])</code>
will split your code into lines and wrap the lines specified by the
<code>highlight_lines</code> option in a span with a class name specified by the
<code>highlight_line_class</code> option (default: <code>hll</code>).</p></li>
<li><p><code>Rouge::Formatters::HTMLLineTable.new(formatter, opts={})</code> will output an HTML
table containing numbered lines, each contained in its own table-row. Options
are:</p>
<ul>
<li><code>start_line: 1</code> - the number of the first row</li>
<li><code>line_id: 'line-%i'</code> - a <code>sprintf</code> template for <code>id</code> attribute with
current line number</li>
<li><code>line_class: 'lineno'</code> - a CSS class for each table-row</li>
<li><code>table_class: 'rouge-line-table'</code> - a CSS class for the table</li>
<li><code>gutter_class: 'rouge-gutter'</code> - a CSS class for the line-number cell</li>
<li><code>code_class: 'rouge-code'</code> - a CSS class for the code cell</li>
</ul></li>
<li><p><code>Rouge::Formatters::HTMLPygments.new(formatter, css_class='codehilite')</code> wraps
the given formatter with div wrappers generally expected by stylesheets
designed for Pygments.</p></li>
<li><p><code>Rouge::Formatters::HTMLTable.new(formatter, opts={})</code> will output an HTML
table containing numbered lines similar to <code>Rouge::Formatters::HTMLLineTable</code>,
except that the table from this formatter has just a single table-row.
Therefore, while the table is more DOM-friendly for JavaScript scripting, long
code lines will mess with the column alignment. Options are:</p>
<ul>
<li><code>start_line: 1</code> - the number of the first line</li>
<li><code>line_format: '%i'</code> - a <code>sprintf</code> template for the line number itself</li>
<li><code>table_class: 'rouge-table'</code> - a CSS class for the table</li>
<li><code>gutter_class: 'rouge-gutter'</code> - a CSS class for the gutter</li>
<li><code>code_class: 'rouge-code'</code> - a CSS class for the code column</li>
</ul></li>
<li><p><code>Rouge::Formatters::HTMLLegacy.new(opts={})</code> is a backwards-compatibility
class intended for users of Rouge 1.x, with options that were supported then.
Options are:</p>
<ul>
<li><code>inline_theme: nil</code> - use an HTMLInline formatter with the given theme</li>
<li><code>line_numbers: false</code> - use an HTMLTable formatter</li>
<li><code>wrap: true</code> - use an HTMLPygments wrapper</li>
<li><code>css_class: 'codehilite'</code> - a CSS class to use for the Pygments wrapper</li>
</ul></li>
<li><p><code>Rouge::Formatters::Terminal256.new(theme)</code> is a formatter for generating
highlighted text for use in the terminal. <code>theme</code> must be an instance of
<code>Rouge::Theme</code>, or a <code>Hash</code> structure with <code>:theme</code> entry.</p></li>
</ul>
<h4 id="writing-your-own-html-formatter">Writing your own HTML formatter</h4>
<p>If the above formatters are not sufficient, and you wish to customize the layout
of the HTML document, we suggest writing your own HTML formatter. This can be
accomplished by subclassing <code>Rouge::Formatters::HTML</code> and overriding specific
methods:</p>
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>MyFormatter</span> <span class='op'><</span> <span class='const'><span class='object_link'><a href="Rouge.html" title="Rouge (module)">Rouge</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rouge/Formatters.html" title="Rouge::Formatters (module)">Formatters</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rouge/Formatters/HTML.html" title="Rouge::Formatters::HTML (class)">HTML</a></span></span>
<span class='comment'># this is the main entry method. override this to customize the behavior of
</span> <span class='comment'># the HTML blob as a whole. it should receive an Enumerable of (token, value)
</span> <span class='comment'># pairs and yield out fragments of the resulting html string. see the docs
</span> <span class='comment'># for the methods available on Token.
</span> <span class='kw'>def</span> <span class='id identifier rubyid_stream'>stream</span><span class='lparen'>(</span><span class='id identifier rubyid_tokens'>tokens</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>yield</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><div class='my-outer-div'></span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_tokens'>tokens</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
<span class='comment'># for every token in the output, we render a span
</span> <span class='kw'>yield</span> <span class='id identifier rubyid_span'>span</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>yield</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'></div></span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='comment'># or, if you need linewise processing, try:
</span> <span class='kw'>def</span> <span class='id identifier rubyid_stream'>stream</span><span class='lparen'>(</span><span class='id identifier rubyid_tokens'>tokens</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='id identifier rubyid_token_lines'>token_lines</span><span class='lparen'>(</span><span class='id identifier rubyid_tokens'>tokens</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_line_tokens'>line_tokens</span><span class='op'>|</span>
<span class='kw'>yield</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><div class='my-cool-line'></span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_line_tokens'>line_tokens</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
<span class='kw'>yield</span> <span class='id identifier rubyid_span'>span</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>yield</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'></div></span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='comment'># Override this method to control how individual spans are rendered.
</span> <span class='comment'># The value `safe_value` will already be HTML-escaped.
</span> <span class='kw'>def</span> <span class='id identifier rubyid_safe_span'>safe_span</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_safe_value'>safe_value</span><span class='rparen'>)</span>
<span class='comment'># in this case, "text" tokens don't get surrounded by a span
</span> <span class='kw'>if</span> <span class='id identifier rubyid_token'>token</span> <span class='op'>==</span> <span class='const'>Token</span><span class='op'>::</span><span class='const'>Tokens</span><span class='op'>::</span><span class='const'>Text</span>
<span class='id identifier rubyid_safe_value'>safe_value</span>
<span class='kw'>else</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><span class=\"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_token'>token</span><span class='period'>.</span><span class='id identifier rubyid_shortname'>shortname</span><span class='embexpr_end'>}</span><span class='tstring_content'>\"></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_safe_value'>safe_value</span><span class='embexpr_end'>}</span><span class='tstring_content'></span></span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
</code></pre>
<h3 id="lexer-options">Lexer Options</h3>
<ul>
<li><p><code>debug: false</code> will print a trace of the lex on stdout.</p></li>
<li><p><code>parent: ''</code> allows you to specify which language the template is inside.</p></li>
</ul>
<h3 id="css-options">CSS Options</h3>
<ul>
<li><code>scope: '.highlight'</code> sets the CSS selector to which styles are applied,
e.g.:</li>
</ul>
<pre class="code ruby"><code class="ruby"> <span class='const'><span class='object_link'><a href="Rouge.html" title="Rouge (module)">Rouge</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rouge/Themes.html" title="Rouge::Themes (module)">Themes</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rouge/Themes/MonokaiSublime.html" title="Rouge::Themes::MonokaiSublime (class)">MonokaiSublime</a></span></span><span class='period'>.</span><span class='id identifier rubyid_render'><span class='object_link'><a href="Rouge/CSSTheme.html#render-instance_method" title="Rouge::CSSTheme#render (method)">render</a></span></span><span class='lparen'>(</span><span class='label'>scope:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>code</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
</code></pre>
<h2 id="documentation">Documentation</h2>
<p>Rouge's documentation is available at <a href="https://rouge-ruby.github.io/docs" title="Rouge's official documentation">rouge-ruby.github.io/docs/</a>.</p>
<h2 id="requirements">Requirements</h2>
<h3 id="ruby">Ruby</h3>
<p>Rouge is compatible with all versions of Ruby from 2.0.0 onwards. It has no
external dependencies.</p>
<h3 id="encodings">Encodings</h3>
<p>Rouge only supports UTF-8 strings. If you'd like to highlight a string with a
different encoding, please convert it to UTF-8 first.</p>
<h2 id="integrations">Integrations</h2>
<ul>
<li>Middleman:
<ul>
<li><a href="https://github.com/middleman/middleman-syntax">middleman-syntax</a> (@bhollis)</li>
<li><a href="https://github.com/Linuus/middleman-rouge">middleman-rouge</a> (@Linuus)</li>
</ul></li>
<li>RDoc: <a href="https://github.com/zzak/rdoc-rouge">rdoc-rouge</a> (@zzak)</li>
<li>Rails: <a href="https://github.com/jacobsimeon/rouge-rails">Rouge::Rails</a> (@jacobsimeon)</li>
</ul>
<h2 id="contributing">Contributing</h2>
<p>We're always excited to welcome new contributors to Rouge. By it's nature, a
syntax highlighter relies for its success on submissions from users of the
languages being highlighted. You can help Rouge by filing bug reports or
developing new lexers.</p>
<p>Everyone interacting in Rouge and its sub-projects' code bases is expected to
follow the Rouge <a href="CODE_OF_CONDUCT.md">Code of Conduct</a>.</p>
<h3 id="bug-reports">Bug Reports</h3>
<p>Rouge uses GitHub's Issues to report bugs. You can <a href="https://github.com/rouge-ruby/rouge/issues/new/choose" title="Choose an issue from the templates">choose</a> from
one of our templates or create a custom issue. Issues that have not been active
for a year are automatically closed by GitHub's <a href="https://probot.github.io" title="Read more about GitHub's Probot">Probot</a>.</p>
<h3 id="developing-lexers">Developing Lexers</h3>
<p><strong>NOTE</strong>: Please don't submit lexers that are copy-pasted from other files.
These submission will be rejected and we don't want you to waste your time.</p>
<p>We want to make it as easy as we can for anyone to contribute a lexer to Rouge.
To help get you started, we have <a href="https://rouge-ruby.github.io/docs/file.LexerDevelopment.html" title="Rouge's lexer development guide">a shiny new guide</a> on lexer
development in the documentation. The best place is to start there.</p>
<p>If you get stuck and need help, submit a pull request with what you have and
make it clear in your submission that the lexer isn't finished yet. We'll do our
best to answer any questions you have and sometimes the best way to do that is
with actual code.</p>
<h3 id="testing-rouge">Testing Rouge</h3>
<p>Once you've cloned the repository from GitHub, you can test the core of Rouge
simply by running <code>rake</code> (no <code>bundle exec</code> required). You can also run a single
test file by setting the <code>TEST</code> environment variable to the path of the desired
test. For example, to test just the <em><code>ruby</code> lexer</em> (located at path
<code>spec/lexers/ruby_spec.rb</code>) simply run the following:</p>
<pre class="code sh"><code class="sh">TEST=spec/lexers/ruby_spec.rb rake
</code></pre>
<p>To test a lexer visually, run <code>rackup</code> from the top-level working directory and
you should have a web server running and ready to go. Visit
<a href="http://localhost:9292">http://localhost:9292</a> to see the full list of Rouge's lexers.</p>
<p>Once you've selected a particular lexer, you can add <code>?debug=1</code> to your URL
string to see a lot of helpful debugging info printed on stdout.</p>
<h2 id="versioning">Versioning</h2>
<p>Rouge uses <a href="http://semver.org/">Semantic Versioning 2.0.0</a>.</p>
<h2 id="maintainers">Maintainers</h2>
<p>Rouge is largely the result of the hard work of unpaid volunteers. It was
originally developed by Jeanine Adkisson (@jneen) and is currently maintained by
Jeanine Adkisson, Drew Blessing (@dblessing), Goro Fuji (@gfx) and Tan Le
(@tancnle).</p>
<h2 id="license">License</h2>
<p>Rouge is released under the MIT license. Please see the <a href="LICENSE">LICENSE</a> file for more
information.</p>
</div></div>
<div id="footer">
Generated on Fri Jun 14 14:26:36 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.3.0).
</div>
</div>
</body>
</html>