ronn-ng 0.10.1.pre2 → 0.10.1.pre4

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 19392851711576551758ca8fca8235a0a9784acd846e560e3808336aa8912d97
4
- data.tar.gz: 8854f5df3e52079e811a4499262c5dd4a3127e309ec6efa2f2ddc35a041a6a1c
3
+ metadata.gz: 24e763c319198b0faa02cb53f80eb6b296eba031e622257bdff747e4f5f80b96
4
+ data.tar.gz: 9ea2a36ecda90be6b1405c66aff2c683999bc9bc2f91d711e8b31f7f8975fd3b
5
5
  SHA512:
6
- metadata.gz: c4e6ea4b5d05c5272714cc98cb34e83beb3b8a3a695c455d1d0c64ade25b43db134d45ea5b7294524bf7650d83127469ac2e45c401d6425f0242a5ed68761b39
7
- data.tar.gz: 1a4846f9941112800514d6b418983278242fe7abb4f97b5ebd908cfe47a4be9fb231e782ef103fa73b12aaf6017528347522d8585067d4d4c89fb53378f4ac3a
6
+ metadata.gz: bca753a51a57dc4a627a60640bf1e3ab3ba319f63968725b426b25feccf783cafc8747901f23622be530592786979569b81695cc9202a2c0cc722d14f4df85c8
7
+ data.tar.gz: a64bff17c7bbdc669828a713430af19bfc49f29fe25d7088b48f5aa86b6f66a9a3a65722b8a7bf8438cf92fb51effd473045a5b286f94b453e70307826b8ed1b
@@ -1,74 +1,86 @@
1
- Ronn-NG CHANGES
2
- ===============
1
+ # Ronn-NG CHANGELOG
3
2
 
4
- Version 0.10.1 (in progress)
5
- ----------------------------
3
+ ## 0.10.1 (unreleased)
6
4
 
7
- Note: The Ronn-NG 0.10.0 release does not exist, due to a RubyGems publishing mistake. 0.10.1 is
8
- the first 0.10.x release.
5
+ This release is focused on bug fixes and updating library dependencies, to get Ronn-NG building and working correctly on recent Linux and macOS releases.
9
6
 
10
- * Switch to GitHub Flavored Markdown, fixing code block rendering (<https://github.com/apjanke/ronn-ng/pull/53>)
11
- * Revert `\[ci]` back to `\(bu)` (<https://github.com/apjanke/ronn-ng/pull/51>)
12
- * Minor fix to single-quote escaping (<https://github.com/apjanke/ronn-ng/issues/55>)
13
- * Elide HTML comments when producing roff output (<https://github.com/apjanke/ronn-ng/issues/65>)
14
- * Remove non-portable `more -i` option (<https://github.com/apjanke/ronn-ng/issues/71>)
15
- * Fix charset in HTML output's Content-Type (<https://github.com/apjanke/ronn-ng/pull/83>)
16
- * Bump to mustache 1.x
7
+ Note: 0.10.1 is the first 0.10.x release, because Ronn-NG 0.10.0 does not exist.
17
8
 
18
- Version 0.10.0 (never)
19
- ---------------------------
9
+ ### Features and Additions
10
+
11
+ * Switch to GitHub Flavored Markdown ([#53](https://github.com/apjanke/ronn-ng/pull/53))
12
+ * Fixes code block rendering
13
+ * doc: Reformat Changelog to match common gem and keep-a-changelog conventions
14
+ * NOTE: Renamed `CHANGES` to `CHANGELOG.md`. Packagers will need to update specs.
15
+ * Bump Ruby to 2.7, gem deps to latest minor versions
16
+
17
+ ### Bug Fixes
18
+
19
+ * Relaxed and fixed dependency versions ([#108](https://github.com/apjanke/ronn-ng/issues/108))
20
+ * Revert `\[ci]` back to `\(bu)` ([#51](https://github.com/apjanke/ronn-ng/pull/51))
21
+ * Fix single-quote escaping ([#55](https://github.com/apjanke/ronn-ng/issues/55))
22
+ * Elide HTML comments when producing roff output ([#65](https://github.com/apjanke/ronn-ng/issues/65))
23
+ * Remove non-portable `more -i` option ([#71](https://github.com/apjanke/ronn-ng/issues/71))
24
+ * Fix charset (utf-8) in HTML output's Content-Type ([#83](https://github.com/apjanke/ronn-ng/pull/83))
25
+ * Psych 4.0 test fix, Ruby 3.x support (from n-ronn) ([#87](https://github.com/apjanke/ronn-ng/issues/87))
26
+ * Fix test failure for angle-bracket items with namespace-like "foo:" prefixes ([#102](https://github.com/apjanke/ronn-ng/issues/102))
27
+ * Inclusion of the "foo:" is now considered correct, matching current code behavior
28
+
29
+ ## 0.10.0 (never released)
20
30
 
21
31
  Doesn't exist due to a RubyGems publishing mistake.
22
32
 
23
- Version 0.9.1 (2020 Apr 09)
24
- ---------------------------
33
+ ## 0.9.1 (2020-04-09)
25
34
 
26
- * Fix underlining issue (<https://github.com/apjanke/ronn-ng/pull/41>)
35
+ * Fix underlining issue ([#41](https://github.com/apjanke/ronn-ng/pull/41))
27
36
 
28
- Version 0.9.0 (2019 Dec 21)
29
- ---------------------------
37
+ ## 0.9.0 (2019-12-21)
30
38
 
31
- * Migrate to kramdown for the underlying Markdown library
39
+ * Migrate to kramdown from rdiscount for the underlying Markdown library
32
40
  * Minor output formatting and documentation improvements
33
41
 
34
- Version 0.8.2 (2019 Mar 5)
35
- --------------------------
42
+ ## 0.8.2 (2019-03-05)
36
43
 
37
44
  * Fixes packaging error in 0.8.1
38
45
 
39
- Version 0.8.1 (2019 Mar 5)
40
- --------------------------
46
+ ## 0.8.1 (2019-03-05)
47
+
48
+ * Fix URL hyphenation bug ([#23](https://github.com/apjanke/ronn-ng/issues/23))
49
+ * Fix ordered-list bustication. ([#24](https://github.com/apjanke/ronn-ng/issues/24))
50
+
51
+ ## 0.8.0 (2018-12-25)
41
52
 
42
- * Fixed URL hyphenation bug. (<https://github.com/apjanke/ronn-ng/issues/23>) (apjanke)
43
- * Fixed ordered-list bustication. (<https://github.com/apjanke/ronn-ng/issues/24>) (apjanke)
53
+ ### Features
44
54
 
45
- Version 0.8.0 (2018 Dec 25)
46
- ---------------------------
55
+ * Add tables support.
56
+ * Add --output-dir option.
57
+ * Migrate from Hpricot to Nokogiri.
47
58
 
48
- * Added tables support. (apjanke)
49
- * Lint & Rubocop fixes. (apjanke)
50
- * Added --output-dir option. (apjanke)
51
- * Support file names with periods in the name section. (apjanke)
52
- * Migrated from Hpricot to Nokogiri. (apjanke)
59
+ ### Bug Fixes
53
60
 
54
- Version 0.7.4 (2018 Dec 22)
55
- ---------------------------
61
+ * Lint & Rubocop fixes
62
+ * Support file names with periods in the name section
56
63
 
57
- * Forked Ronn-NG from original Ronn. (apjanke)
58
- * Minor bug fixes: #4, #5 (apjanke)
64
+ ## 0.7.4 (2018-12-22)
59
65
 
60
- Original Ronn CHANGES
61
- =====================
66
+ * Forked Ronn-NG from original Ronn
62
67
 
63
- Version 0.7.3 (2010 June 24)
64
- ----------------------------
68
+ ### Bug Fixes
69
+
70
+ * Fix test for HTML meta elements ([#4](https://github.com/apjanke/ronn-ng/issues/4))
71
+ * Fix circumflex rendering ([#5](https://github.com/apjanke/ronn-ng/issues/4))
72
+
73
+ ## Original Ronn changelog
74
+
75
+ The following sections are the changes from the original Ronn project, before Ronn-NG was forked from it. They were pulled in from its existing CHANGES file and reformatted.
76
+
77
+ ## 0.7.3 (2010-06-24)
65
78
 
66
79
  * Fixed a major bug in roff output due to overly aggressive doublequote
67
80
  escaping. Paragraphs and code blocks were not being displayed if they
68
81
  included a double-quote character. (rtomayko, pawelz)
69
82
 
70
- Version 0.7.0 (2010 June 21)
71
- ----------------------------
83
+ ## 0.7.0 (2010-06-21)
72
84
 
73
85
  * HTML: Manual references (like 'grep(1)', 'ls(1)', etc.) are now hyperlinked
74
86
  based on a set of name -> URL mappings defined in an index.txt file. The index
@@ -101,16 +113,14 @@ Version 0.7.0 (2010 June 21)
101
113
  * Performance improvements. Fixed a few cases where HTML was being reparsed
102
114
  needlessly, tuned dom selectors, ... (rtomayko)
103
115
 
104
- Version 0.6.6 (2010 June 13)
105
- ----------------------------
116
+ ## 0.6.6 (2010-06-13)
106
117
 
107
118
  Small bug fix release fixes whitespace stripping between adjacent
108
119
  inline elements in roff output (adamv, rtomayko)
109
120
 
110
- Version 0.6 (2010 June 13)
111
- --------------------------
121
+ ## 0.6 (2010-06-13)
112
122
 
113
- Features:
123
+ ### Features
114
124
 
115
125
  * HTML: New styling system:
116
126
  ronn --style=toc,print program.1.ronn
@@ -168,7 +178,7 @@ Features:
168
178
  establish the default values of the --manual, --organization, and --date
169
179
  options (rtomayko)
170
180
 
171
- Bugs:
181
+ ### Bug Fixes
172
182
 
173
183
  * ROFF: Don't crash with empty preformatted blocks (sunaku)
174
184
 
@@ -179,7 +189,7 @@ Bugs:
179
189
  * ROFF: All ['".] characters are backslash escaped in roff output. These
180
190
  characters are used for various roff macro syntax (rtomayko)
181
191
 
182
- Deprecations, Obsoletions:
192
+ ### Deprecations, Obsoletions
183
193
 
184
194
  * The ronn(1) command line interface has changed in ways that are not
185
195
  backward-compatible with previous versions of ronn. The --build option is
@@ -209,8 +219,7 @@ Deprecations, Obsoletions:
209
219
  shipped with the latest version of rdiscount, however.
210
220
  (rtomayko, sunaku)
211
221
 
212
- 0.5 (2010 April 24)
213
- -------------------
222
+ ## 0.5 (2010-04-24)
214
223
 
215
224
  * Fixed a bug in roff output where multiple successive newlines were being
216
225
  collapsed into a single newline in preformatted output.
@@ -221,9 +230,7 @@ Deprecations, Obsoletions:
221
230
  * The compatibility shims that allowed the ronn command to be invoked as "ron",
222
231
  and the ronn library to be required as "ron", have been removed.
223
232
 
224
-
225
- 0.4 (2010 March 08)
226
- -------------------
233
+ ## 0.4 (2010-03-08)
227
234
 
228
235
  * Ron has been renamed "Ronn", including the "ronn" command and the "ronn"
229
236
  library. Compatibility shims are included in this release but will be removed
data/README.md CHANGED
@@ -8,23 +8,23 @@ terminal display, and also to HTML for the web.
8
8
 
9
9
  The source format includes all of Markdown but has a more rigid structure and
10
10
  syntax extensions for features commonly found in manpages (definition lists,
11
- link notation, etc.). The ronn-format(7) manual page defines the format in
11
+ link notation, etc.). The ronn-format(7) man page defines the format in
12
12
  detail.
13
13
 
14
14
  The `*.ronn` files found in the [`man/`][1] directory show off a wide range of
15
15
  ronn capabilities:
16
16
 
17
- * [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) command -
18
- [source file](http://github.com/apjanke/ronn-ng/blob/main/man/ronn.1.ronn),
19
- [roff output](http://github.com/apjanke/ronn-ng/blob/main/man/ronn.1)
17
+ * [ronn(1)](https://rtomayko.github.io/ronn/ronn-format.7.html) command
18
+ [source file](https://github.com/apjanke/ronn-ng/blob/main/man/ronn.1.ronn),
19
+ [roff output](https://github.com/apjanke/ronn-ng/blob/main/man/ronn.1)
20
20
 
21
- * [ronn-format(7)](http://rtomayko.github.com/ronn/ronn-format.7) -
22
- [source file](http://github.com/apjanke/ronn-ng/blob/main/man/ronn-format.7.ronn),
23
- [roff output](http://github.com/apjanke/ronn-ng/blob/main/man/ronn-format.7)
21
+ * [ronn-format(7)](https://rtomayko.github.io/ronn/ronn-format.7.html) file format –
22
+ [source file](https://github.com/apjanke/ronn-ng/blob/main/man/ronn-format.7.ronn),
23
+ [roff output](https://github.com/apjanke/ronn-ng/blob/main/man/ronn-format.7)
24
24
 
25
- [1]: http://github.com/apjanke/ronn-ng/tree/main/man
25
+ [1]: https://github.com/apjanke/ronn-ng/tree/main/man
26
26
 
27
- As an alternative, you might want to check out [pandoc](http://johnmacfarlane.net/pandoc/) which can also convert markdown into roff manual pages.
27
+ As an alternative, you might want to check out [pandoc](https://pandoc.org/) which can also convert markdown into roff manual pages.
28
28
 
29
29
  ## Installation
30
30
 
@@ -78,7 +78,7 @@ View roff output with man(1):
78
78
  $ man man/ronn.5
79
79
  ```
80
80
 
81
- The [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) manual page includes
81
+ The [ronn(1)](https://rtomayko.github.io/ronn/ronn-format.7.html) man page includes
82
82
  comprehensive documentation on `ronn` command line options.
83
83
 
84
84
  ## Background
@@ -141,7 +141,7 @@ some bugs fixed.
141
141
 
142
142
  MIT License.
143
143
 
144
- Ronn is Copyright (C) 2010 [Ryan Tomayko](http://tomayko.com/about).
144
+ Ronn is Copyright (C) 2010 [Ryan Tomayko](https://github.com/rtomayko).
145
145
 
146
146
  New Ronn-NG material is Copyright (C) 2018-2022 [Andrew Janke](https://apjanke.net) and other contributors.
147
147
 
data/bin/ronn CHANGED
@@ -241,7 +241,7 @@ documents.each do |doc|
241
241
  end
242
242
  end
243
243
 
244
- # Write index.txt files
244
+ # write index.txt files
245
245
 
246
246
  if write_index
247
247
  indexes = documents.map(&:index).uniq
data/lib/ronn.rb CHANGED
@@ -40,6 +40,6 @@ module Ronn
40
40
  end
41
41
 
42
42
  # value generated by: rake rev
43
- REV = '0.10.1.pre2'.freeze
43
+ REV = '0.10.1.pre4'.freeze
44
44
  VERSION = version
45
45
  end
data/man/index.html CHANGED
@@ -48,7 +48,7 @@
48
48
  <p class='aux'>
49
49
  <a href='https://github.com/apjanke/ronn-ng#readme'>README</a>,
50
50
  <a href='https://github.com/apjanke/ronn-ng/blob/main/INSTALLING.md'>INSTALLING</a>,
51
- <a href='https://github.com/apjanke/ronn-ng/blob/main/CHANGES'>CHANGES</a>,
51
+ <a href='https://github.com/apjanke/ronn-ng/blob/main/CHANGELOG.md'>CHANGELOG.md</a>,
52
52
  <a href='https://github.com/apjanke/ronn-ng/blob/main/LICENSE.txt'>LICENSE</a>,
53
53
  <a href='https://github.com/apjanke/ronn-ng/blob/main/AUTHORS'>AUTHORS</a>
54
54
  </p>
@@ -56,23 +56,24 @@
56
56
  <h4>Manuals</h4>
57
57
  <dl>
58
58
  <dt><a class='man-ref' href='ronn.1.html'>ronn(1)</a></dt>
59
- <dd>manual authoring tool</dd>
59
+ <dd>manpage authoring tool</dd>
60
60
 
61
61
  <dt><a class='man-ref' href='ronn-format.7.html'>ronn-format(7)</a></dt>
62
- <dd>markdown-based text format for authoring manpages</dd>
62
+ <dd>Markdown-based text format for authoring manpages</dd>
63
63
  </dl>
64
64
 
65
65
  <h4>See Also</h4>
66
66
  <p class='also'>
67
67
  <a class='man-ref' href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man5/manpages.5.html">manpages(5)</a>,
68
- <a class='man-ref' href="https://daringfireball.net/projects/markdown/syntax">markdown(7)</a>,
69
- <a class='man-ref' href="https://www.man7.org/linux/man-pages/man1/man.1.html">man(1)</a>,
68
+ <a class='man-ref' href="https://daringfireball.net/projects/markdown/syntax">Markdown syntax</a>,
69
+ <a class='man-ref' href="https://man7.org/linux/man-pages/man1/man.1.html">man(1)</a>,
70
70
  <a class='man-ref' href="https://man7.org/linux/man-pages/man7/roff.7.html">roff(7)</a>,
71
71
  <a class='man-ref' href="https://man7.org/linux/man-pages/man1/groff.1.html">groff(1)</a>,
72
- <a class='man-ref' href="https://mustache.github.io/mustache.5.html">mustache(5)</a>
72
+ <a class='man-ref' href="https://mustache.github.io/mustache.5.html">mustache(5)</a>,
73
+ <a class='man-ref' href="https://linux.die.net/man/1/pandoc">pandoc(1)</a>
73
74
  </p>
74
75
 
75
- <p class='copy'>Copyright &copy; 2010 Ryan Tomayko, &copy; 2018, 2019, 2020, 2022 Andrew Janke, &copy; 2022 Takuya Noguchi</p>
76
+ <p class='copy'>Copyright &copy; 2010 Ryan Tomayko, &copy; 2018, 2019, 2020, 2022, 2023 Andrew Janke, &copy; 2022 Takuya Noguchi</p>
76
77
  </div>
77
78
  </body>
78
79
  </html>
data/man/index.txt CHANGED
@@ -13,3 +13,4 @@ fork(2) https://man7.org/linux/man-pages/man2/fork.2.html
13
13
  man(1) https://man7.org/linux/man-pages/man1/man.1.html
14
14
  markdown(7) https://daringfireball.net/projects/markdown/syntax
15
15
  manpages(5) https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man5/manpages.5.html
16
+ pandoc(1) https://linux.die.net/man/1/pandoc
data/man/ronn-format.7 CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.10.1
2
- .\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre2
3
- .TH "RONN\-FORMAT" "7" "December 2022" "Ronn-NG 0.10.1.pre2" "Ronn Manual"
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre4
3
+ .TH "RONN\-FORMAT" "7" "January 2024" "Ronn-NG 0.10.1.pre4" "Ronn Manual"
4
4
  .SH "NAME"
5
5
  \fBronn\-format\fR \- manual authoring format based on Markdown
6
6
  .SH "SYNOPSIS"
@@ -86,7 +86,7 @@ Section headings should be all uppercase and may not contain inline markup\.
86
86
  Manpages have a limited set of text formatting capabilities\. There's basically \fBboldface\fR and \fIitalics\fR (often displayed using \fIunderline\fR)\. Ronn uses the following bits of markdown(7) to accomplish this:
87
87
  .TP
88
88
  \fB\e`backticks\e`\fR (markdown compatible)
89
- Code, flags, commands, and noun\-like things; typically displayed in in \fBboldface\fR\. All text included within \fBbackticks\fR is displayed literally; other inline markup is not processed\. HTML output: \fB<code>\fR\.
89
+ Code, flags, commands, and noun\-like things; typically displayed in \fBboldface\fR\. All text included within \fBbackticks\fR is displayed literally; other inline markup is not processed\. HTML output: \fB<code>\fR\.
90
90
  .TP
91
91
  \fB**double\-stars**\fR (markdown compatible)
92
92
  Also displayed in boldface\. Unlike backticks, inline markup is processed\. HTML output: \fB<strong>\fR\.
@@ -90,7 +90,7 @@ Manpages have a limited set of text formatting capabilities. There's basically
90
90
  Ronn uses the following bits of markdown(7) to accomplish this:
91
91
 
92
92
  * <code>\`backticks\`</code> (markdown compatible):
93
- Code, flags, commands, and noun-like things; typically displayed in in
93
+ Code, flags, commands, and noun-like things; typically displayed in
94
94
  <b>boldface</b>. All text included within `backticks` is displayed
95
95
  literally; other inline markup is not processed. HTML output:
96
96
  `<code>`.
data/man/ronn.1 CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.10.1
2
- .\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre2
3
- .TH "RONN" "1" "January 2023" "Ronn-NG 0.10.1.pre2" "Ronn Manual"
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre4
3
+ .TH "RONN" "1" "December 2023" "Ronn-NG 0.10.1.pre4" "Ronn Manual"
4
4
  .SH "NAME"
5
5
  \fBronn\fR \- convert markdown files to manpages
6
6
  .SH "SYNOPSIS"
@@ -31,23 +31,28 @@ Source files must be in UTF\-8 encoding, or the encoding specified by the \fB\-E
31
31
  When building roff or HTML output files, destination filenames are determined by taking the basename of the input \fIfile\fR and adding the appropriate file extension (or removing the file extension in the case of roff output)\. For example, executing \fBronn example\.1\.ronn\fR generates \fBexample\.1\fR with roff output and \fBexample\.1\.html\fR with HTML output\.
32
32
  .SH "OPTIONS"
33
33
  These options control whether output is written to file(s), standard output, or directly to a man pager\.
34
- .IP "\(bu" 4
35
- \fB\-m\fR, \fB\-\-man\fR: Don't generate files, display \fIfile\fRs as if man(1) were invoked on the roff output file\. This simulates default man behavior by piping the roff output through groff(1) and the paging program specified by the \fBMANPAGER\fR environment variable\.
36
- .IP "\(bu" 4
37
- \fB\-S\fR, \fB\-\-server\fR: Don't generate files, start an HTTP server at \fIhttp://localhost:1207/\fR and serve dynamically generated HTML for the set of input \fIfile\fRs\. A file named \fIexample\.2\.ronn\fR is served as \fI/example\.2\.html\fR\. There's also an index page at the root with links to each \fIfile\fR\.
34
+ .TP
35
+ \fB\-m\fR, \fB\-\-man\fR
36
+ Don't generate files, display \fIfile\fRs as if man(1) were invoked on the roff output file\. This simulates default man behavior by piping the roff output through groff(1) and the paging program specified by the \fBMANPAGER\fR environment variable\.
37
+ .TP
38
+ \fB\-S\fR, \fB\-\-server\fR
39
+ Don't generate files, start an HTTP server at \fIhttp://localhost:1207/\fR and serve dynamically generated HTML for the set of input \fIfile\fRs\. A file named \fIexample\.2\.ronn\fR is served as \fI/example\.2\.html\fR\. There's also an index page at the root with links to each \fIfile\fR\.
38
40
  .IP
39
41
  The server respects the \fB\-\-style\fR and document attribute options (\fB\-\-manual\fR, \fB\-\-date\fR, etc\.)\. These same options can be varied at request time by giving them as query parameters: \fB?manual=FOO&style=dark,toc\fR
40
42
  .IP
41
43
  \fINOTE: The builtin server is designed to assist in the process of writing and styling manuals\. It is in no way recommended as a general purpose web server\.\fR
42
- .IP "\(bu" 4
43
- \fB\-\-port\fR=\fIport\fR When used with \fB\-S\fR/\fB\-\-server\fR, runs the server at the specified port instead of the default port 1207\.
44
- .IP "\(bu" 4
45
- \fB\-\-pipe\fR: Don't generate files, write generated output to standard output\. This is the default behavior when ronn source text is piped in on standard input and no \fIfile\fR arguments are provided\.
46
- .IP "\(bu" 4
47
- \fB\-o\fR=\fIdirectory\fR, \fB\-\-output\-dir\fR=\fIdirectory\fR: Write generated files to the specified directory instead of the default location\.
48
- .IP "\(bu" 4
49
- \fB\-E\fR=\fIencoding\fR, \fB\-\-encoding\fR=<encoding: Specify the encoding that input files are in\. Default is UTF\-8, regardless of user's locale settings\. Input sent to STDIN is always treated as UTF\-8, regardless of whether \fB\-E\fR is passed\.
50
- .IP "" 0
44
+ .TP
45
+ \fB\-\-port\fR=\fIport\fR
46
+ When used with \fB\-S\fR/\fB\-\-server\fR, runs the server at the specified port instead of the default port 1207\.
47
+ .TP
48
+ \fB\-\-pipe\fR
49
+ Don't generate files, write generated output to standard output\. This is the default behavior when ronn source text is piped in on standard input and no \fIfile\fR arguments are provided\.
50
+ .TP
51
+ \fB\-o\fR=\fIdirectory\fR, \fB\-\-output\-dir\fR=\fIdirectory\fR
52
+ Write generated files to the specified directory instead of the default location\.
53
+ .TP
54
+ \fB\-E\fR=\fIencoding\fR, \fB\-\-encoding\fR=\fIencoding\fR
55
+ Specify the encoding that input files are in\. Default is UTF\-8, regardless of user's locale settings\. Input sent to STDIN is always treated as UTF\-8, regardless of whether \fB\-E\fR is passed\.
51
56
  .P
52
57
  Format options control the files \fBronn\fR generates, or the output format when the \fB\-\-pipe\fR argument is specified\. When no format options are given, both \fB\-\-roff\fR and \fB\-\-html\fR are assumed\.
53
58
  .TP
data/man/ronn.1.ronn CHANGED
@@ -70,7 +70,7 @@ directly to a man pager.
70
70
  and styling manuals. It is in no way recommended as a general purpose web
71
71
  server.*
72
72
 
73
- * `--port`=<port>
73
+ * `--port`=<port>:
74
74
  When used with `-S`/`--server`, runs the server at the specified port instead
75
75
  of the default port 1207.
76
76
 
@@ -83,7 +83,7 @@ directly to a man pager.
83
83
  Write generated files to the specified directory instead of the default
84
84
  location.
85
85
 
86
- * `-E`=<encoding>, `--encoding`=<encoding:
86
+ * `-E`=<encoding>, `--encoding`=<encoding>:
87
87
  Specify the encoding that input files are in. Default is UTF-8, regardless
88
88
  of user's locale settings. Input sent to STDIN is always treated as UTF-8,
89
89
  regardless of whether `-E` is passed.
data/ronn-ng.gemspec CHANGED
@@ -1,10 +1,13 @@
1
1
  Gem::Specification.new do |s|
2
2
  s.name = 'ronn-ng'
3
- s.version = '0.10.1.pre2'
3
+ s.version = '0.10.1.pre4'
4
+ # As of 2023-09, ronn-ng targets and is tested on Ruby 2.7 for deployment. It'll mostly
5
+ # work on lower versions, but in effect requires >= 2.7 because it needs nokogiri
6
+ # >= 1.14.3 for correct tag name handling, and that nokogiri requires Ruby 2.7.
4
7
  s.required_ruby_version = '>= 2.4'
5
8
 
6
9
  s.summary = 'Builds man pages from Markdown'
7
- s.description = 'Ronn-NG builds manuals in HTML and Unix man page format from Markdown. Ronn-NG is a modern, maintained fork of the original Ronn.'
10
+ s.description = 'Ronn-NG builds manuals in Unix man page and HTML format from Markdown. Ronn-NG is a modern, maintained fork of the original Ronn.'
8
11
  s.homepage = 'https://github.com/apjanke/ronn-ng'
9
12
  s.license = 'MIT'
10
13
 
@@ -14,13 +17,13 @@ Gem::Specification.new do |s|
14
17
  s.metadata = {
15
18
  'bug_tracker_uri' => 'https://github.com/apjanke/ronn-ng/issues',
16
19
  'source_code_uri' => 'https://github.com/apjanke/ronn-ng',
17
- 'changelog_uri' => 'https://github.com/apjanke/ronn-ng/blob/main/CHANGES'
20
+ 'changelog_uri' => 'https://github.com/apjanke/ronn-ng/blob/main/CHANGELOG.md'
18
21
  }
19
22
 
20
23
  # = MANIFEST =
21
24
  s.files = %w[
22
25
  AUTHORS
23
- CHANGES
26
+ CHANGELOG.md
24
27
  INSTALLING.md
25
28
  LICENSE.txt
26
29
  README.md
@@ -58,15 +61,19 @@ Gem::Specification.new do |s|
58
61
  s.test_files = s.files.select { |path| path =~ /^test\/.*_test.rb/ }
59
62
 
60
63
  s.extra_rdoc_files = %w[LICENSE.txt AUTHORS]
61
- s.add_dependency 'kramdown', '~> 2.1'
62
- s.add_dependency 'kramdown-parser-gfm', '>= 1.0.1', '< 1.2'
63
- s.add_dependency 'mustache', '~> 1.0'
64
- s.add_dependency 'nokogiri', '~> 1.10', '>= 1.10.10'
65
- s.add_development_dependency 'rack', '~> 2.2', '>= 2.2.3'
66
- s.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
67
- s.add_development_dependency 'rubocop', '~> 1.12.1'
68
- s.add_development_dependency 'sinatra', '~> 2.0', '>= 2.0.8'
69
- s.add_development_dependency 'test-unit', '~> 3.3', '>= 3.3.6'
64
+ s.add_dependency 'kramdown', '>= 2.1'
65
+ s.add_dependency 'kramdown-parser-gfm', '>= 1.0.1'
66
+ s.add_dependency 'mustache', '>= 0.7.0'
67
+ # nokogiri <= 1.14.2 mishandle tag names with ":" in them (see #102)
68
+ s.add_dependency 'nokogiri', '>= 1.14.3'
69
+ # rack < 2.2.3.0 have security vulns
70
+ s.add_development_dependency 'rack', '>= 2.2.3'
71
+ s.add_development_dependency 'rake', '>= 13.0.3'
72
+ # just a guess based on what I used to use
73
+ s.add_development_dependency 'rubocop', '>= 1.25.1'
74
+ # sinatra < 2.2.3 have security vulns
75
+ s.add_development_dependency 'sinatra', '>= 2.2.3'
76
+ s.add_development_dependency 'test-unit', '>= 3.2.7'
70
77
 
71
78
  s.rdoc_options = ['--line-numbers', '--inline-source', '--title', 'Ronn']
72
79
  s.require_paths = %w[lib]
metadata CHANGED
@@ -1,27 +1,27 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ronn-ng
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.1.pre2
4
+ version: 0.10.1.pre4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Andrew Janke
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-01-17 00:00:00.000000000 Z
11
+ date: 2024-01-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: kramdown
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
19
  version: '2.1'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - "~>"
24
+ - - ">="
25
25
  - !ruby/object:Gem::Version
26
26
  version: '2.1'
27
27
  - !ruby/object:Gem::Dependency
@@ -31,9 +31,6 @@ dependencies:
31
31
  - - ">="
32
32
  - !ruby/object:Gem::Version
33
33
  version: 1.0.1
34
- - - "<"
35
- - !ruby/object:Gem::Version
36
- version: '1.2'
37
34
  type: :runtime
38
35
  prerelease: false
39
36
  version_requirements: !ruby/object:Gem::Requirement
@@ -41,50 +38,38 @@ dependencies:
41
38
  - - ">="
42
39
  - !ruby/object:Gem::Version
43
40
  version: 1.0.1
44
- - - "<"
45
- - !ruby/object:Gem::Version
46
- version: '1.2'
47
41
  - !ruby/object:Gem::Dependency
48
42
  name: mustache
49
43
  requirement: !ruby/object:Gem::Requirement
50
44
  requirements:
51
- - - "~>"
45
+ - - ">="
52
46
  - !ruby/object:Gem::Version
53
- version: '1.0'
47
+ version: 0.7.0
54
48
  type: :runtime
55
49
  prerelease: false
56
50
  version_requirements: !ruby/object:Gem::Requirement
57
51
  requirements:
58
- - - "~>"
52
+ - - ">="
59
53
  - !ruby/object:Gem::Version
60
- version: '1.0'
54
+ version: 0.7.0
61
55
  - !ruby/object:Gem::Dependency
62
56
  name: nokogiri
63
57
  requirement: !ruby/object:Gem::Requirement
64
58
  requirements:
65
- - - "~>"
66
- - !ruby/object:Gem::Version
67
- version: '1.10'
68
59
  - - ">="
69
60
  - !ruby/object:Gem::Version
70
- version: 1.10.10
61
+ version: 1.14.3
71
62
  type: :runtime
72
63
  prerelease: false
73
64
  version_requirements: !ruby/object:Gem::Requirement
74
65
  requirements:
75
- - - "~>"
76
- - !ruby/object:Gem::Version
77
- version: '1.10'
78
66
  - - ">="
79
67
  - !ruby/object:Gem::Version
80
- version: 1.10.10
68
+ version: 1.14.3
81
69
  - !ruby/object:Gem::Dependency
82
70
  name: rack
83
71
  requirement: !ruby/object:Gem::Requirement
84
72
  requirements:
85
- - - "~>"
86
- - !ruby/object:Gem::Version
87
- version: '2.2'
88
73
  - - ">="
89
74
  - !ruby/object:Gem::Version
90
75
  version: 2.2.3
@@ -92,9 +77,6 @@ dependencies:
92
77
  prerelease: false
93
78
  version_requirements: !ruby/object:Gem::Requirement
94
79
  requirements:
95
- - - "~>"
96
- - !ruby/object:Gem::Version
97
- version: '2.2'
98
80
  - - ">="
99
81
  - !ruby/object:Gem::Version
100
82
  version: 2.2.3
@@ -102,77 +84,59 @@ dependencies:
102
84
  name: rake
103
85
  requirement: !ruby/object:Gem::Requirement
104
86
  requirements:
105
- - - "~>"
106
- - !ruby/object:Gem::Version
107
- version: '12.3'
108
87
  - - ">="
109
88
  - !ruby/object:Gem::Version
110
- version: 12.3.3
89
+ version: 13.0.3
111
90
  type: :development
112
91
  prerelease: false
113
92
  version_requirements: !ruby/object:Gem::Requirement
114
93
  requirements:
115
- - - "~>"
116
- - !ruby/object:Gem::Version
117
- version: '12.3'
118
94
  - - ">="
119
95
  - !ruby/object:Gem::Version
120
- version: 12.3.3
96
+ version: 13.0.3
121
97
  - !ruby/object:Gem::Dependency
122
98
  name: rubocop
123
99
  requirement: !ruby/object:Gem::Requirement
124
100
  requirements:
125
- - - "~>"
101
+ - - ">="
126
102
  - !ruby/object:Gem::Version
127
- version: 1.12.1
103
+ version: 1.25.1
128
104
  type: :development
129
105
  prerelease: false
130
106
  version_requirements: !ruby/object:Gem::Requirement
131
107
  requirements:
132
- - - "~>"
108
+ - - ">="
133
109
  - !ruby/object:Gem::Version
134
- version: 1.12.1
110
+ version: 1.25.1
135
111
  - !ruby/object:Gem::Dependency
136
112
  name: sinatra
137
113
  requirement: !ruby/object:Gem::Requirement
138
114
  requirements:
139
- - - "~>"
140
- - !ruby/object:Gem::Version
141
- version: '2.0'
142
115
  - - ">="
143
116
  - !ruby/object:Gem::Version
144
- version: 2.0.8
117
+ version: 2.2.3
145
118
  type: :development
146
119
  prerelease: false
147
120
  version_requirements: !ruby/object:Gem::Requirement
148
121
  requirements:
149
- - - "~>"
150
- - !ruby/object:Gem::Version
151
- version: '2.0'
152
122
  - - ">="
153
123
  - !ruby/object:Gem::Version
154
- version: 2.0.8
124
+ version: 2.2.3
155
125
  - !ruby/object:Gem::Dependency
156
126
  name: test-unit
157
127
  requirement: !ruby/object:Gem::Requirement
158
128
  requirements:
159
- - - "~>"
160
- - !ruby/object:Gem::Version
161
- version: '3.3'
162
129
  - - ">="
163
130
  - !ruby/object:Gem::Version
164
- version: 3.3.6
131
+ version: 3.2.7
165
132
  type: :development
166
133
  prerelease: false
167
134
  version_requirements: !ruby/object:Gem::Requirement
168
135
  requirements:
169
- - - "~>"
170
- - !ruby/object:Gem::Version
171
- version: '3.3'
172
136
  - - ">="
173
137
  - !ruby/object:Gem::Version
174
- version: 3.3.6
175
- description: Ronn-NG builds manuals in HTML and Unix man page format from Markdown.
138
+ version: 3.2.7
139
+ description: Ronn-NG builds manuals in Unix man page and HTML format from Markdown.
176
140
  Ronn-NG is a modern, maintained fork of the original Ronn.
177
141
  email: floss@apjanke.net
178
142
  executables:
@@ -183,7 +147,7 @@ extra_rdoc_files:
183
147
  - AUTHORS
184
148
  files:
185
149
  - AUTHORS
186
- - CHANGES
150
+ - CHANGELOG.md
187
151
  - INSTALLING.md
188
152
  - LICENSE.txt
189
153
  - README.md
@@ -220,7 +184,7 @@ licenses:
220
184
  metadata:
221
185
  bug_tracker_uri: https://github.com/apjanke/ronn-ng/issues
222
186
  source_code_uri: https://github.com/apjanke/ronn-ng
223
- changelog_uri: https://github.com/apjanke/ronn-ng/blob/main/CHANGES
187
+ changelog_uri: https://github.com/apjanke/ronn-ng/blob/main/CHANGELOG.md
224
188
  post_install_message:
225
189
  rdoc_options:
226
190
  - "--line-numbers"
@@ -236,11 +200,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
236
200
  version: '2.4'
237
201
  required_rubygems_version: !ruby/object:Gem::Requirement
238
202
  requirements:
239
- - - ">"
203
+ - - ">="
240
204
  - !ruby/object:Gem::Version
241
- version: 1.3.1
205
+ version: '0'
242
206
  requirements: []
243
- rubygems_version: 3.4.4
207
+ rubygems_version: 3.5.3
244
208
  signing_key:
245
209
  specification_version: 4
246
210
  summary: Builds man pages from Markdown