ronn-ng 0.10.1.pre1 → 0.10.1.pre2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (81) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHORS +11 -7
  3. data/CHANGES +7 -1
  4. data/INSTALLING.md +29 -27
  5. data/LICENSE.txt +1 -1
  6. data/README.md +15 -9
  7. data/Rakefile +1 -1
  8. data/bin/ronn +1 -1
  9. data/lib/ronn/document.rb +4 -1
  10. data/lib/ronn/roff.rb +4 -0
  11. data/lib/ronn/template/default.html +1 -1
  12. data/lib/ronn.rb +4 -6
  13. data/man/index.html +14 -14
  14. data/man/index.txt +9 -9
  15. data/man/ronn-format.7 +2 -2
  16. data/man/ronn.1 +7 -7
  17. data/man/ronn.1.ronn +7 -6
  18. data/ronn-ng.gemspec +6 -69
  19. metadata +19 -80
  20. data/Gemfile +0 -2
  21. data/Gemfile.lock +0 -70
  22. data/test/angle_bracket_syntax.html +0 -27
  23. data/test/angle_bracket_syntax.roff +0 -24
  24. data/test/angle_bracket_syntax.ronn +0 -22
  25. data/test/backticks.html +0 -14
  26. data/test/backticks.ronn +0 -10
  27. data/test/basic_document.html +0 -8
  28. data/test/basic_document.ronn +0 -4
  29. data/test/circumflexes.ronn +0 -1
  30. data/test/code_blocks.html +0 -38
  31. data/test/code_blocks.roff +0 -38
  32. data/test/code_blocks.ronn +0 -41
  33. data/test/code_blocks_regression +0 -19
  34. data/test/code_blocks_regression.html +0 -38
  35. data/test/code_blocks_regression.ronn +0 -40
  36. data/test/contest.rb +0 -70
  37. data/test/custom_title_document.html +0 -6
  38. data/test/custom_title_document.ronn +0 -5
  39. data/test/definition_list_syntax.html +0 -25
  40. data/test/definition_list_syntax.roff +0 -19
  41. data/test/definition_list_syntax.ronn +0 -18
  42. data/test/dots_at_line_start_test.roff +0 -19
  43. data/test/dots_at_line_start_test.ronn +0 -12
  44. data/test/ellipses.roff +0 -7
  45. data/test/ellipses.ronn +0 -7
  46. data/test/entity_encoding_test.html +0 -42
  47. data/test/entity_encoding_test.roff +0 -51
  48. data/test/entity_encoding_test.ronn +0 -34
  49. data/test/index.txt +0 -8
  50. data/test/markdown_syntax.html +0 -954
  51. data/test/markdown_syntax.roff +0 -907
  52. data/test/markdown_syntax.ronn +0 -881
  53. data/test/middle_paragraph.html +0 -14
  54. data/test/middle_paragraph.roff +0 -9
  55. data/test/middle_paragraph.ronn +0 -10
  56. data/test/missing_spaces.roff +0 -7
  57. data/test/missing_spaces.ronn +0 -2
  58. data/test/nested_list.ronn +0 -19
  59. data/test/nested_list_with_code.html +0 -14
  60. data/test/nested_list_with_code.roff +0 -11
  61. data/test/nested_list_with_code.ronn +0 -6
  62. data/test/ordered_list.html +0 -28
  63. data/test/ordered_list.roff +0 -25
  64. data/test/ordered_list.ronn +0 -21
  65. data/test/page.with.periods.in.name.5.ronn +0 -4
  66. data/test/pre_block_with_quotes.roff +0 -8
  67. data/test/pre_block_with_quotes.ronn +0 -6
  68. data/test/section_reference_links.html +0 -16
  69. data/test/section_reference_links.roff +0 -7
  70. data/test/section_reference_links.ronn +0 -12
  71. data/test/single_quotes.html +0 -11
  72. data/test/single_quotes.roff +0 -5
  73. data/test/single_quotes.ronn +0 -9
  74. data/test/tables.ronn +0 -24
  75. data/test/test_ronn.rb +0 -124
  76. data/test/test_ronn_document.rb +0 -186
  77. data/test/test_ronn_index.rb +0 -73
  78. data/test/titleless_document.html +0 -9
  79. data/test/titleless_document.ronn +0 -3
  80. data/test/underline_spacing_test.roff +0 -13
  81. data/test/underline_spacing_test.ronn +0 -11
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ronn-ng
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.1.pre1
4
+ version: 0.10.1.pre2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Andrew Janke
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-12-22 00:00:00.000000000 Z
11
+ date: 2023-01-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: kramdown
@@ -28,16 +28,22 @@ dependencies:
28
28
  name: kramdown-parser-gfm
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - "~>"
31
+ - - ">="
32
32
  - !ruby/object:Gem::Version
33
33
  version: 1.0.1
34
+ - - "<"
35
+ - !ruby/object:Gem::Version
36
+ version: '1.2'
34
37
  type: :runtime
35
38
  prerelease: false
36
39
  version_requirements: !ruby/object:Gem::Requirement
37
40
  requirements:
38
- - - "~>"
41
+ - - ">="
39
42
  - !ruby/object:Gem::Version
40
43
  version: 1.0.1
44
+ - - "<"
45
+ - !ruby/object:Gem::Version
46
+ version: '1.2'
41
47
  - !ruby/object:Gem::Dependency
42
48
  name: mustache
43
49
  requirement: !ruby/object:Gem::Requirement
@@ -58,20 +64,20 @@ dependencies:
58
64
  requirements:
59
65
  - - "~>"
60
66
  - !ruby/object:Gem::Version
61
- version: '1.9'
67
+ version: '1.10'
62
68
  - - ">="
63
69
  - !ruby/object:Gem::Version
64
- version: 1.9.0
70
+ version: 1.10.10
65
71
  type: :runtime
66
72
  prerelease: false
67
73
  version_requirements: !ruby/object:Gem::Requirement
68
74
  requirements:
69
75
  - - "~>"
70
76
  - !ruby/object:Gem::Version
71
- version: '1.9'
77
+ version: '1.10'
72
78
  - - ">="
73
79
  - !ruby/object:Gem::Version
74
- version: 1.9.0
80
+ version: 1.10.10
75
81
  - !ruby/object:Gem::Dependency
76
82
  name: rack
77
83
  requirement: !ruby/object:Gem::Requirement
@@ -118,20 +124,14 @@ dependencies:
118
124
  requirements:
119
125
  - - "~>"
120
126
  - !ruby/object:Gem::Version
121
- version: '0.88'
122
- - - ">="
123
- - !ruby/object:Gem::Version
124
- version: 0.88.0
127
+ version: 1.12.1
125
128
  type: :development
126
129
  prerelease: false
127
130
  version_requirements: !ruby/object:Gem::Requirement
128
131
  requirements:
129
132
  - - "~>"
130
133
  - !ruby/object:Gem::Version
131
- version: '0.88'
132
- - - ">="
133
- - !ruby/object:Gem::Version
134
- version: 0.88.0
134
+ version: 1.12.1
135
135
  - !ruby/object:Gem::Dependency
136
136
  name: sinatra
137
137
  requirement: !ruby/object:Gem::Requirement
@@ -173,6 +173,7 @@ dependencies:
173
173
  - !ruby/object:Gem::Version
174
174
  version: 3.3.6
175
175
  description: Ronn-NG builds manuals in HTML and Unix man page format from Markdown.
176
+ Ronn-NG is a modern, maintained fork of the original Ronn.
176
177
  email: floss@apjanke.net
177
178
  executables:
178
179
  - ronn
@@ -183,8 +184,6 @@ extra_rdoc_files:
183
184
  files:
184
185
  - AUTHORS
185
186
  - CHANGES
186
- - Gemfile
187
- - Gemfile.lock
188
187
  - INSTALLING.md
189
188
  - LICENSE.txt
190
189
  - README.md
@@ -215,73 +214,13 @@ files:
215
214
  - man/ronn.1
216
215
  - man/ronn.1.ronn
217
216
  - ronn-ng.gemspec
218
- - test/angle_bracket_syntax.html
219
- - test/angle_bracket_syntax.roff
220
- - test/angle_bracket_syntax.ronn
221
- - test/backticks.html
222
- - test/backticks.ronn
223
- - test/basic_document.html
224
- - test/basic_document.ronn
225
- - test/circumflexes.ronn
226
- - test/code_blocks.html
227
- - test/code_blocks.roff
228
- - test/code_blocks.ronn
229
- - test/code_blocks_regression
230
- - test/code_blocks_regression.html
231
- - test/code_blocks_regression.ronn
232
- - test/contest.rb
233
- - test/custom_title_document.html
234
- - test/custom_title_document.ronn
235
- - test/definition_list_syntax.html
236
- - test/definition_list_syntax.roff
237
- - test/definition_list_syntax.ronn
238
- - test/dots_at_line_start_test.roff
239
- - test/dots_at_line_start_test.ronn
240
- - test/ellipses.roff
241
- - test/ellipses.ronn
242
- - test/entity_encoding_test.html
243
- - test/entity_encoding_test.roff
244
- - test/entity_encoding_test.ronn
245
- - test/index.txt
246
- - test/markdown_syntax.html
247
- - test/markdown_syntax.roff
248
- - test/markdown_syntax.ronn
249
- - test/middle_paragraph.html
250
- - test/middle_paragraph.roff
251
- - test/middle_paragraph.ronn
252
- - test/missing_spaces.roff
253
- - test/missing_spaces.ronn
254
- - test/nested_list.ronn
255
- - test/nested_list_with_code.html
256
- - test/nested_list_with_code.roff
257
- - test/nested_list_with_code.ronn
258
- - test/ordered_list.html
259
- - test/ordered_list.roff
260
- - test/ordered_list.ronn
261
- - test/page.with.periods.in.name.5.ronn
262
- - test/pre_block_with_quotes.roff
263
- - test/pre_block_with_quotes.ronn
264
- - test/section_reference_links.html
265
- - test/section_reference_links.roff
266
- - test/section_reference_links.ronn
267
- - test/single_quotes.html
268
- - test/single_quotes.roff
269
- - test/single_quotes.ronn
270
- - test/tables.ronn
271
- - test/test_ronn.rb
272
- - test/test_ronn_document.rb
273
- - test/test_ronn_index.rb
274
- - test/titleless_document.html
275
- - test/titleless_document.ronn
276
- - test/underline_spacing_test.roff
277
- - test/underline_spacing_test.ronn
278
217
  homepage: https://github.com/apjanke/ronn-ng
279
218
  licenses:
280
219
  - MIT
281
220
  metadata:
282
221
  bug_tracker_uri: https://github.com/apjanke/ronn-ng/issues
283
222
  source_code_uri: https://github.com/apjanke/ronn-ng
284
- changelog_uri: https://github.com/apjanke/ronn-ng/blob/master/CHANGES
223
+ changelog_uri: https://github.com/apjanke/ronn-ng/blob/main/CHANGES
285
224
  post_install_message:
286
225
  rdoc_options:
287
226
  - "--line-numbers"
@@ -301,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
301
240
  - !ruby/object:Gem::Version
302
241
  version: 1.3.1
303
242
  requirements: []
304
- rubygems_version: 3.1.4
243
+ rubygems_version: 3.4.4
305
244
  signing_key:
306
245
  specification_version: 4
307
246
  summary: Builds man pages from Markdown
data/Gemfile DELETED
@@ -1,2 +0,0 @@
1
- source 'https://rubygems.org'
2
- gemspec
data/Gemfile.lock DELETED
@@ -1,70 +0,0 @@
1
- PATH
2
- remote: .
3
- specs:
4
- ronn-ng (0.10.1.pre1)
5
- kramdown (~> 2.1)
6
- kramdown-parser-gfm (~> 1.0.1)
7
- mustache (~> 1.0)
8
- nokogiri (~> 1.9, >= 1.9.0)
9
-
10
- GEM
11
- remote: https://rubygems.org/
12
- specs:
13
- ast (2.4.1)
14
- kramdown (2.3.0)
15
- rexml
16
- kramdown-parser-gfm (1.0.1)
17
- kramdown (~> 2.0)
18
- mini_portile2 (2.4.0)
19
- mustache (1.1.1)
20
- mustermann (1.1.1)
21
- ruby2_keywords (~> 0.0.1)
22
- nokogiri (1.10.10)
23
- mini_portile2 (~> 2.4.0)
24
- parallel (1.20.1)
25
- parser (2.7.2.0)
26
- ast (~> 2.4.1)
27
- power_assert (1.2.0)
28
- rack (2.2.3)
29
- rack-protection (2.1.0)
30
- rack
31
- rainbow (3.0.0)
32
- rake (12.3.3)
33
- regexp_parser (2.0.1)
34
- rexml (3.2.4)
35
- rubocop (0.93.1)
36
- parallel (~> 1.10)
37
- parser (>= 2.7.1.5)
38
- rainbow (>= 2.2.2, < 4.0)
39
- regexp_parser (>= 1.8)
40
- rexml
41
- rubocop-ast (>= 0.6.0)
42
- ruby-progressbar (~> 1.7)
43
- unicode-display_width (>= 1.4.0, < 2.0)
44
- rubocop-ast (1.3.0)
45
- parser (>= 2.7.1.5)
46
- ruby-progressbar (1.10.1)
47
- ruby2_keywords (0.0.2)
48
- sinatra (2.1.0)
49
- mustermann (~> 1.0)
50
- rack (~> 2.2)
51
- rack-protection (= 2.1.0)
52
- tilt (~> 2.0)
53
- test-unit (3.3.7)
54
- power_assert
55
- tilt (2.0.10)
56
- unicode-display_width (1.7.0)
57
-
58
- PLATFORMS
59
- ruby
60
-
61
- DEPENDENCIES
62
- rack (~> 2.2, >= 2.2.3)
63
- rake (~> 12.3, >= 12.3.3)
64
- ronn-ng!
65
- rubocop (~> 0.88, >= 0.88.0)
66
- sinatra (~> 2.0, >= 2.0.8)
67
- test-unit (~> 3.3, >= 3.3.6)
68
-
69
- BUNDLED WITH
70
- 2.1.4
@@ -1,27 +0,0 @@
1
- <div class='mp'>
2
-
3
- <h2 id="NAME">NAME</h2>
4
- <p class="man-name">
5
- <code>angle_bracket_syntax</code> - <span class="man-whatis">angle bracket syntax test</span>
6
- </p>
7
- <p>A <var>WORD</var> in angle brackets is converted to <var>WORD</var>,</p>
8
-
9
- <pre><code>except when &lt;WORD&gt; is
10
- part of a preformatted
11
- code block,
12
- </code></pre>
13
-
14
- <p>or when <code>&lt;WORD&gt;</code> is enclosed in backticks.</p>
15
-
16
- <p>or when <var>WORD</var> has a <dot.> or <colon>.</colon></dot.></p>
17
-
18
- <h2 id="Escaping-angle-brackets">Escaping angle brackets</h2>
19
-
20
- <p>You can escape &lt;angle&gt; &lt;brackets&gt; with backslashes, since we're using GitHub Flavored Markdown.</p>
21
-
22
- <p>Example:</p>
23
-
24
- <p><code>pxzgrep</code> [<code>-p</code>&lt;n&gt;] [<code>-V</code>] [&lt;xzgrep options&gt;] &lt;pattern&gt; &lt;file1&gt; &lt;file2&gt; [&lt;more files&gt;]</p>
25
-
26
- <p>(Though really you should just put that in a fenced code block.)</p>
27
- </div>
@@ -1,24 +0,0 @@
1
- .TH "ANGLE_BRACKET_SYNTAX" "5" "January 1979" ""
2
- .SH "NAME"
3
- \fBangle_bracket_syntax\fR \- angle bracket syntax test
4
- .P
5
- A \fIWORD\fR in angle brackets is converted to \fIWORD\fR,
6
- .IP "" 4
7
- .nf
8
- except when <WORD> is
9
- part of a preformatted
10
- code block,
11
- .fi
12
- .IP "" 0
13
- .P
14
- or when \fB<WORD>\fR is enclosed in backticks\.
15
- .P
16
- or when \fIWORD\fR has a
17
- .SH "Escaping angle brackets"
18
- You can escape <angle> <brackets> with backslashes, since we're using GitHub Flavored Markdown\.
19
- .P
20
- Example:
21
- .P
22
- \fBpxzgrep\fR [\fB\-p\fR<n>] [\fB\-V\fR] [<xzgrep options>] <pattern> <file1> <file2> [<more files>]
23
- .P
24
- (Though really you should just put that in a fenced code block\.)
@@ -1,22 +0,0 @@
1
- angle_bracket_syntax(5) -- angle bracket syntax test
2
- ====================================================
3
-
4
- A <WORD> in angle brackets is converted to <var>WORD</var>,
5
-
6
- except when <WORD> is
7
- part of a preformatted
8
- code block,
9
-
10
- or when `<WORD>` is enclosed in backticks.
11
-
12
- or when <WORD> has a <dot.> or <foo:colon>.
13
-
14
- ## Escaping angle brackets
15
-
16
- You can escape \<angle\> \<brackets\> with backslashes, since we're using GitHub Flavored Markdown.
17
-
18
- Example:
19
-
20
- `pxzgrep` [`-p`\<n\>] [`-V`] [\<xzgrep options\>] \<pattern\> \<file1\> \<file2\> [\<more files\>]
21
-
22
- (Though really you should just put that in a fenced code block.)
data/test/backticks.html DELETED
@@ -1,14 +0,0 @@
1
- <div class='mp'>
2
-
3
- <h2 id="NAME">NAME</h2>
4
- <p class="man-name">
5
- <code>backticks</code> - <span class="man-whatis">testing the link index with backticks</span>
6
- </p>
7
- <p><a class="man-ref" href="http://man.cx/grep(1)">grep<span class="s">(1)</span></a></p>
8
-
9
- <p><a class="man-ref" href="http://man.cx/grep(1)"><code>grep</code><span class="s">(1)</span></a></p>
10
-
11
- <p><span class="man-ref">man<span class="s">(1)</span></span></p>
12
-
13
- <p><span class="man-ref"><code>man</code><span class="s">(1)</span></span></p>
14
- </div>
data/test/backticks.ronn DELETED
@@ -1,10 +0,0 @@
1
- backticks(7) -- testing the link index with backticks
2
- =====================================================
3
-
4
- grep(1)
5
-
6
- `grep`(1)
7
-
8
- man(1)
9
-
10
- `man`(1)
@@ -1,8 +0,0 @@
1
- <div class='mp'>
2
-
3
- <h2 id="NAME">NAME</h2>
4
- <p class="man-name">
5
- <code>simple</code> - <span class="man-whatis">a simple ronn example</span>
6
- </p>
7
- <p>This document created by ronn.</p>
8
- </div>
@@ -1,4 +0,0 @@
1
- simple(7) -- a simple ronn example
2
- =================================
3
-
4
- This document created by ronn.
@@ -1 +0,0 @@
1
- y = 2^x
@@ -1,38 +0,0 @@
1
- <div class='mp'>
2
-
3
- <h1 id="Example-Code-Blocks">Example Code Blocks</h1>
4
- <h2 id="Basic-code-block">Basic code block</h2>
5
-
6
- <pre><code>Hello, world!
7
- </code></pre>
8
-
9
- <h2 id="Language-identified-code-blocks">Language-identified code blocks</h2>
10
-
11
- <pre><code class="language-html">&lt;html&gt;
12
- &lt;head&gt;
13
- &lt;title&gt;Hello, world!&lt;/title&gt;
14
- &lt;/head&gt;
15
- &lt;body&gt;
16
- Hello, world!
17
- &lt;/body&gt;
18
- &lt;/html&gt;
19
- </code></pre>
20
-
21
- <h2 id="Interspersed-code-blocks-and-text">Interspersed code blocks and text</h2>
22
-
23
- <p>Some text.</p>
24
-
25
- <pre><code>Some code.
26
- </code></pre>
27
-
28
- <p>Here's some &lt;pre&gt; text.</p>
29
-
30
- <pre>
31
- This is pre text.
32
- </pre>
33
-
34
- <p>Some more text.</p>
35
-
36
- <pre><code>Some more code.
37
- </code></pre>
38
- </div>
@@ -1,38 +0,0 @@
1
- .TH "CODE_BLOCKS" "" "January 1979" ""
2
- .SH "Basic code block"
3
- .nf
4
- Hello, world!
5
- .fi
6
- .SH "Language\-identified code blocks"
7
- .nf
8
- <html>
9
- <head>
10
- <title>Hello, world!</title>
11
- </head>
12
- <body>
13
- Hello, world!
14
- </body>
15
- </html>
16
- .fi
17
- .SH "Interspersed code blocks and text"
18
- Some text\.
19
- .IP "" 4
20
- .nf
21
- Some code\.
22
- .fi
23
- .IP "" 0
24
- .P
25
- Here's some <pre> text\.
26
- .IP "" 4
27
- .nf
28
- This is pre text\.
29
- .fi
30
- .IP "" 0
31
- .P
32
- Some more text\.
33
- .IP "" 4
34
- .nf
35
- Some more code\.
36
- .fi
37
- .IP "" 0
38
-
@@ -1,41 +0,0 @@
1
- Example Code Blocks
2
- ===================
3
-
4
- ## Basic code block
5
-
6
- ```
7
- Hello, world!
8
- ```
9
-
10
- ## Language-identified code blocks
11
-
12
- ```html
13
- <html>
14
- <head>
15
- <title>Hello, world!</title>
16
- </head>
17
- <body>
18
- Hello, world!
19
- </body>
20
- </html>
21
- ```
22
-
23
- ## Interspersed code blocks and text
24
-
25
- Some text.
26
-
27
- ```
28
- Some code.
29
- ```
30
-
31
- Here's some &lt;pre> text.
32
-
33
- <pre>
34
- This is pre text.
35
- </pre>
36
-
37
- Some more text.
38
-
39
- ```
40
- Some more code.
41
- ```
@@ -1,19 +0,0 @@
1
- .\" generated with Ronn-NG/v0.9.1
2
- .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "CODE_BLOCKS_REGRESSION" "" "July 2020" ""
4
- .SH "In the text:"
5
- This is Renzo\'s code\.
6
- .P
7
- Debian\'s lintian returns the following warning: acute\-accent\-in\-manual\-page
8
- .P
9
- This manual page uses the \' groff sequence\. Usually, the intent to generate an apostrophe, but that sequence actually renders as a an acute accent\.
10
- .P
11
- For an apostrophe or a single closing quote, use plain \'\. For single opening quote, i\.e\. a straight downward line \' like the one used in shell commands, use \e(aq\.
12
- .SH "Basic code block"
13
- The situation is even worse when there are code blocks, mainly code chunks or commands\. E\.g\., copy\-paste fails\.
14
- .P
15
- Type the following command \fBecho \'Hello World\'\fR\.
16
- .P
17
- \fBbash $ echo \'hello world\'\fR
18
- .P
19
- The following code cannot be compiled: \fBC int main() { int example = 42; switch (example) { case \'a\': return 10; default: return 42; } }\fR
@@ -1,38 +0,0 @@
1
- <div class='mp'>
2
-
3
- <h1 id="Example-Quote-Error">Example Quote Error</h1>
4
- <h2 id="In-the-text-">In the text:</h2>
5
-
6
- <p>This is Renzo's code.</p>
7
-
8
- <p>Debian's lintian returns the following warning:
9
- acute-accent-in-manual-page</p>
10
-
11
- <p>This manual page uses the ' groff sequence. Usually, the intent to
12
- generate an apostrophe, but that sequence actually renders as a an acute
13
- accent.</p>
14
-
15
- <p>For an apostrophe or a single closing quote, use plain '. For single
16
- opening quote, i.e. a straight downward line ' like the one used in
17
- shell commands, use \(aq.</p>
18
-
19
- <h2 id="Basic-code-block">Basic code block</h2>
20
-
21
- <p>The situation is even worse when there are code blocks, mainly code
22
- chunks or commands. E.g., copy-paste fails.</p>
23
-
24
- <p>Type the following command <code>echo 'Hello World'</code>.</p>
25
-
26
- <pre><code class="language-bash">$ echo 'hello world'
27
- </code></pre>
28
-
29
- <p>The following code cannot be compiled:</p>
30
- <pre><code class="language-C">int main() {
31
- int example = 42;
32
- switch (example) {
33
- case 'a': return 10;
34
- default: return 42;
35
- }
36
- }
37
- </code></pre>
38
- </div>
@@ -1,40 +0,0 @@
1
- Example Quote Error
2
- ===================
3
-
4
- ## In the text:
5
-
6
- This is Renzo's code.
7
-
8
- Debian's lintian returns the following warning:
9
- acute-accent-in-manual-page
10
-
11
- This manual page uses the \' groff sequence. Usually, the intent to
12
- generate an apostrophe, but that sequence actually renders as a an acute
13
- accent.
14
-
15
- For an apostrophe or a single closing quote, use plain '. For single
16
- opening quote, i.e. a straight downward line ' like the one used in
17
- shell commands, use &#92;(aq.
18
-
19
- ## Basic code block
20
-
21
- The situation is even worse when there are code blocks, mainly code
22
- chunks or commands. E.g., copy-paste fails.
23
-
24
- Type the following command `echo 'Hello World'`.
25
-
26
- ``` bash
27
- $ echo 'hello world'
28
- ```
29
-
30
- The following code cannot be compiled:
31
- ``` C
32
- int main() {
33
- int example = 42;
34
- switch (example) {
35
- case 'a': return 10;
36
- default: return 42;
37
- }
38
- }
39
- ```
40
-
data/test/contest.rb DELETED
@@ -1,70 +0,0 @@
1
- require 'test/unit'
2
-
3
- module Test
4
- module Unit
5
- # TestSuite loads a default test if the suite is empty, whose purpose is to
6
- # fail. Since having empty contexts is a common practice, we decided to
7
- # overwrite TestSuite#empty? in order to allow them. Having a failure when no
8
- # tests have been defined seems counter-intuitive.
9
- class TestSuite
10
- def empty?
11
- false
12
- end
13
- end
14
-
15
- # Contest adds +teardown+, +test+ and +context+ as class methods, and the
16
- # instance methods +setup+ and +teardown+ now iterate on the corresponding
17
- # blocks. Note that all setup and teardown blocks must be defined with the
18
- # block syntax. Adding setup or teardown instance methods defeats the purpose
19
- # of this library.
20
- class TestCase
21
- def self.setup(&block)
22
- define_method :setup do
23
- super(&block)
24
- instance_eval(&block)
25
- end
26
- end
27
-
28
- def self.teardown(&block)
29
- define_method :teardown do
30
- instance_eval(&block)
31
- super(&block)
32
- end
33
- end
34
-
35
- def self.context(name, &block)
36
- subclass = Class.new(self)
37
- remove_tests(subclass)
38
- subclass.class_eval(&block) if block_given?
39
- const_set(context_name(name), subclass)
40
- end
41
-
42
- def self.test(name, &block)
43
- define_method(test_name(name), &block)
44
- end
45
-
46
- class << self
47
- alias should test
48
- alias describe context
49
- end
50
-
51
- def self.context_name(name)
52
- "Test#{sanitize_name(name).gsub(/(^| )(\w)/) { $2.upcase }}".to_sym
53
- end
54
-
55
- def self.test_name(name)
56
- "test_#{sanitize_name(name).gsub(/\s+/, '_')}".to_sym
57
- end
58
-
59
- def self.sanitize_name(name)
60
- name.gsub(/\W+/, ' ').strip
61
- end
62
-
63
- def self.remove_tests(subclass)
64
- subclass.public_instance_methods.grep(/^test_/).each do |meth|
65
- subclass.send(:undef_method, meth.to_sym)
66
- end
67
- end
68
- end
69
- end
70
- end
@@ -1,6 +0,0 @@
1
- <div class='mp'>
2
-
3
- <h1 id="This-is-a-custom-title">This is a custom title</h1>
4
- <p>It doesn't define the name or section of this manual page and is
5
- output as a simple <code>&lt;h1&gt;</code> instead of a <code>NAME</code> section.</p>
6
- </div>
@@ -1,5 +0,0 @@
1
- This is a custom title
2
- ======================
3
-
4
- It doesn't define the name or section of this manual page and is
5
- output as a simple `<h1>` instead of a `NAME` section.