ronn-ng 0.10.1.pre3 → 0.10.1.pre6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/{CHANGES → CHANGELOG.md} +64 -56
- data/README.md +11 -11
- data/Rakefile +10 -5
- data/bin/ronn +5 -6
- data/lib/ronn/document.rb +2 -2
- data/lib/ronn/roff.rb +4 -4
- data/lib/ronn/template.rb +1 -1
- data/lib/ronn.rb +1 -1
- data/man/index.html +4 -4
- data/man/ronn-format.7 +3 -3
- data/man/ronn-format.7.ronn +1 -1
- data/man/ronn.1 +2 -2
- data/ronn-ng.gemspec +23 -17
- metadata +62 -35
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9505d966f681ed78efa33c1fcef840066c560b9ba763e05bff0c3ff567e6fce7
|
4
|
+
data.tar.gz: dd026bd76f479eab06f15dec890aa9e659d9bd7cc43e333ca4c48424a56317ca
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fce7a366f7e13dcf9e0baae53c75813f26c61950bf68bc353392baf82eba5797707a3ef3353ba070e31fdd8cb47c001f3d4eb0b3005b3b9e91e6587497b92ed6
|
7
|
+
data.tar.gz: 604b73cf59fb339641289056d9358b57c7db79f1a1eb56ad4fa9a6b65ebadd24ddc976769ded142a07c7a2fc5217450a1a4cb4abebc6d3dce9113dc1c825ea99
|
data/{CHANGES → CHANGELOG.md}
RENAMED
@@ -1,74 +1,87 @@
|
|
1
|
-
Ronn-NG
|
2
|
-
===============
|
1
|
+
# Ronn-NG CHANGELOG
|
3
2
|
|
4
|
-
|
5
|
-
----------------------------
|
3
|
+
## 0.10.1 (unreleased)
|
6
4
|
|
7
|
-
|
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
|
-
|
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
|
-
|
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
|
+
* Tweak `ronn --version` output: remove GitHub URL and format it "ronn <ver> (Ronn-NG)"
|
17
|
+
|
18
|
+
### Bug Fixes
|
19
|
+
|
20
|
+
* Relaxed and fixed dependency versions ([#108](https://github.com/apjanke/ronn-ng/issues/108))
|
21
|
+
* Revert `\[ci]` back to `\(bu)` ([#51](https://github.com/apjanke/ronn-ng/pull/51))
|
22
|
+
* Fix single-quote escaping ([#55](https://github.com/apjanke/ronn-ng/issues/55))
|
23
|
+
* Elide HTML comments when producing roff output ([#65](https://github.com/apjanke/ronn-ng/issues/65))
|
24
|
+
* Remove non-portable `more -i` option ([#71](https://github.com/apjanke/ronn-ng/issues/71))
|
25
|
+
* Fix charset (utf-8) in HTML output's Content-Type ([#83](https://github.com/apjanke/ronn-ng/pull/83))
|
26
|
+
* Psych 4.0 test fix, Ruby 3.x support (from n-ronn) ([#87](https://github.com/apjanke/ronn-ng/issues/87))
|
27
|
+
* Fix test failure for angle-bracket items with namespace-like "foo:" prefixes ([#102](https://github.com/apjanke/ronn-ng/issues/102))
|
28
|
+
* Inclusion of the "foo:" is now considered correct, matching current code behavior
|
29
|
+
|
30
|
+
## 0.10.0 (never released)
|
20
31
|
|
21
32
|
Doesn't exist due to a RubyGems publishing mistake.
|
22
33
|
|
23
|
-
|
24
|
-
---------------------------
|
34
|
+
## 0.9.1 (2020-04-09)
|
25
35
|
|
26
|
-
* Fix underlining issue (
|
36
|
+
* Fix underlining issue ([#41](https://github.com/apjanke/ronn-ng/pull/41))
|
27
37
|
|
28
|
-
|
29
|
-
---------------------------
|
38
|
+
## 0.9.0 (2019-12-21)
|
30
39
|
|
31
|
-
* Migrate to kramdown for the underlying Markdown library
|
40
|
+
* Migrate to kramdown from rdiscount for the underlying Markdown library
|
32
41
|
* Minor output formatting and documentation improvements
|
33
42
|
|
34
|
-
|
35
|
-
--------------------------
|
43
|
+
## 0.8.2 (2019-03-05)
|
36
44
|
|
37
45
|
* Fixes packaging error in 0.8.1
|
38
46
|
|
39
|
-
|
40
|
-
|
47
|
+
## 0.8.1 (2019-03-05)
|
48
|
+
|
49
|
+
* Fix URL hyphenation bug ([#23](https://github.com/apjanke/ronn-ng/issues/23))
|
50
|
+
* Fix ordered-list bustication. ([#24](https://github.com/apjanke/ronn-ng/issues/24))
|
51
|
+
|
52
|
+
## 0.8.0 (2018-12-25)
|
41
53
|
|
42
|
-
|
43
|
-
* Fixed ordered-list bustication. (<https://github.com/apjanke/ronn-ng/issues/24>) (apjanke)
|
54
|
+
### Features
|
44
55
|
|
45
|
-
|
46
|
-
|
56
|
+
* Add tables support.
|
57
|
+
* Add --output-dir option.
|
58
|
+
* Migrate from Hpricot to Nokogiri.
|
47
59
|
|
48
|
-
|
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)
|
60
|
+
### Bug Fixes
|
53
61
|
|
54
|
-
|
55
|
-
|
62
|
+
* Lint & Rubocop fixes
|
63
|
+
* Support file names with periods in the name section
|
56
64
|
|
57
|
-
|
58
|
-
* Minor bug fixes: #4, #5 (apjanke)
|
65
|
+
## 0.7.4 (2018-12-22)
|
59
66
|
|
60
|
-
|
61
|
-
=====================
|
67
|
+
* Forked Ronn-NG from original Ronn
|
62
68
|
|
63
|
-
|
64
|
-
|
69
|
+
### Bug Fixes
|
70
|
+
|
71
|
+
* Fix test for HTML meta elements ([#4](https://github.com/apjanke/ronn-ng/issues/4))
|
72
|
+
* Fix circumflex rendering ([#5](https://github.com/apjanke/ronn-ng/issues/4))
|
73
|
+
|
74
|
+
## Original Ronn changelog
|
75
|
+
|
76
|
+
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.
|
77
|
+
|
78
|
+
## 0.7.3 (2010-06-24)
|
65
79
|
|
66
80
|
* Fixed a major bug in roff output due to overly aggressive doublequote
|
67
81
|
escaping. Paragraphs and code blocks were not being displayed if they
|
68
82
|
included a double-quote character. (rtomayko, pawelz)
|
69
83
|
|
70
|
-
|
71
|
-
----------------------------
|
84
|
+
## 0.7.0 (2010-06-21)
|
72
85
|
|
73
86
|
* HTML: Manual references (like 'grep(1)', 'ls(1)', etc.) are now hyperlinked
|
74
87
|
based on a set of name -> URL mappings defined in an index.txt file. The index
|
@@ -101,16 +114,14 @@ Version 0.7.0 (2010 June 21)
|
|
101
114
|
* Performance improvements. Fixed a few cases where HTML was being reparsed
|
102
115
|
needlessly, tuned dom selectors, ... (rtomayko)
|
103
116
|
|
104
|
-
|
105
|
-
----------------------------
|
117
|
+
## 0.6.6 (2010-06-13)
|
106
118
|
|
107
119
|
Small bug fix release fixes whitespace stripping between adjacent
|
108
120
|
inline elements in roff output (adamv, rtomayko)
|
109
121
|
|
110
|
-
|
111
|
-
--------------------------
|
122
|
+
## 0.6 (2010-06-13)
|
112
123
|
|
113
|
-
Features
|
124
|
+
### Features
|
114
125
|
|
115
126
|
* HTML: New styling system:
|
116
127
|
ronn --style=toc,print program.1.ronn
|
@@ -168,7 +179,7 @@ Features:
|
|
168
179
|
establish the default values of the --manual, --organization, and --date
|
169
180
|
options (rtomayko)
|
170
181
|
|
171
|
-
|
182
|
+
### Bug Fixes
|
172
183
|
|
173
184
|
* ROFF: Don't crash with empty preformatted blocks (sunaku)
|
174
185
|
|
@@ -179,7 +190,7 @@ Bugs:
|
|
179
190
|
* ROFF: All ['".] characters are backslash escaped in roff output. These
|
180
191
|
characters are used for various roff macro syntax (rtomayko)
|
181
192
|
|
182
|
-
Deprecations, Obsoletions
|
193
|
+
### Deprecations, Obsoletions
|
183
194
|
|
184
195
|
* The ronn(1) command line interface has changed in ways that are not
|
185
196
|
backward-compatible with previous versions of ronn. The --build option is
|
@@ -209,8 +220,7 @@ Deprecations, Obsoletions:
|
|
209
220
|
shipped with the latest version of rdiscount, however.
|
210
221
|
(rtomayko, sunaku)
|
211
222
|
|
212
|
-
0.5 (2010
|
213
|
-
-------------------
|
223
|
+
## 0.5 (2010-04-24)
|
214
224
|
|
215
225
|
* Fixed a bug in roff output where multiple successive newlines were being
|
216
226
|
collapsed into a single newline in preformatted output.
|
@@ -221,9 +231,7 @@ Deprecations, Obsoletions:
|
|
221
231
|
* The compatibility shims that allowed the ronn command to be invoked as "ron",
|
222
232
|
and the ronn library to be required as "ron", have been removed.
|
223
233
|
|
224
|
-
|
225
|
-
0.4 (2010 March 08)
|
226
|
-
-------------------
|
234
|
+
## 0.4 (2010-03-08)
|
227
235
|
|
228
236
|
* Ron has been renamed "Ronn", including the "ronn" command and the "ronn"
|
229
237
|
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)
|
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)](
|
18
|
-
[source file](
|
19
|
-
[roff output](
|
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)](
|
22
|
-
[source file](
|
23
|
-
[roff output](
|
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]:
|
25
|
+
[1]: https://github.com/apjanke/ronn-ng/tree/main/man
|
26
26
|
|
27
|
-
As an alternative, you might want to check out [pandoc](
|
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)](
|
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](
|
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/Rakefile
CHANGED
@@ -7,13 +7,14 @@ ROOTDIR = File.expand_path(__dir__).sub(/#{Dir.pwd}(?=\/)/, '.')
|
|
7
7
|
LIBDIR = "#{ROOTDIR}/lib".freeze
|
8
8
|
BINDIR = "#{ROOTDIR}/bin".freeze
|
9
9
|
|
10
|
+
desc 'Set up environment'
|
10
11
|
task :environment do
|
11
12
|
$LOAD_PATH.unshift ROOTDIR unless $LOAD_PATH.include?(ROOTDIR)
|
12
13
|
$LOAD_PATH.unshift LIBDIR unless $LOAD_PATH.include?(LIBDIR)
|
13
14
|
require_library 'nokogiri'
|
14
15
|
require_library 'kramdown'
|
15
16
|
ENV['RUBYLIB'] = $LOAD_PATH.join(':')
|
16
|
-
ENV['PATH'] = "#{BINDIR}:#{ENV
|
17
|
+
ENV['PATH'] = "#{BINDIR}:#{ENV.fetch('PATH', nil)}"
|
17
18
|
end
|
18
19
|
|
19
20
|
desc 'Run tests'
|
@@ -66,11 +67,12 @@ end
|
|
66
67
|
# PACKAGING ============================================================
|
67
68
|
|
68
69
|
# Rev Ronn::VERSION
|
70
|
+
desc 'Bump package version'
|
69
71
|
task :rev do
|
70
72
|
rev = ENV['REV'] || `git describe --tags`.chomp
|
71
73
|
data = File.read('lib/ronn.rb')
|
72
74
|
data.gsub!(/^( *)REV *=.*/, "\\1REV = '#{rev.sub(/\Av/, '')}'.freeze")
|
73
|
-
File.
|
75
|
+
File.binwrite('lib/ronn.rb', data)
|
74
76
|
puts "revision: #{rev}"
|
75
77
|
puts "version: #{`ruby -Ilib -rronn -e 'puts Ronn::VERSION'`}"
|
76
78
|
end
|
@@ -120,14 +122,16 @@ file 'ronn-ng.gemspec' => FileList['{lib,test,bin}/**', 'Rakefile'] do |f|
|
|
120
122
|
files = `git ls-files`
|
121
123
|
.split("\n")
|
122
124
|
.sort
|
123
|
-
.
|
124
|
-
.reject { |file| file =~
|
125
|
+
.grep_v(/^\./)
|
126
|
+
# .reject { |file| file =~ /^\./ }
|
127
|
+
.grep_v(/^doc/)
|
128
|
+
# .reject { |file| file =~ /^doc/ }
|
125
129
|
.map { |file| " #{file}" }
|
126
130
|
.join("\n")
|
127
131
|
# piece file back together and write...
|
128
132
|
manifest = " s.files = %w[\n#{files}\n ]\n"
|
129
133
|
spec = [head, manifest, tail].join(" # = MANIFEST =\n")
|
130
|
-
File.
|
134
|
+
File.write(f.name, spec)
|
131
135
|
puts "updated #{f.name}"
|
132
136
|
end
|
133
137
|
|
@@ -145,6 +149,7 @@ rescue LoadError => e
|
|
145
149
|
end
|
146
150
|
|
147
151
|
# make .wrong test files right
|
152
|
+
desc 'Mark *.wrong test files as right'
|
148
153
|
task :right do
|
149
154
|
Dir['test/*.wrong'].each do |file|
|
150
155
|
dest = file.sub(/\.wrong$/, '')
|
data/bin/ronn
CHANGED
@@ -47,7 +47,7 @@ Encoding.default_external = Encoding::UTF_8
|
|
47
47
|
def usage
|
48
48
|
puts File.readlines(__FILE__)
|
49
49
|
.grep(/^# \/.*/)
|
50
|
-
.map { |line| line.chomp[4
|
50
|
+
.map { |line| line.chomp[4..] }
|
51
51
|
.join("\n")
|
52
52
|
end
|
53
53
|
|
@@ -94,7 +94,7 @@ output_dir = nil
|
|
94
94
|
# Environment variables
|
95
95
|
|
96
96
|
%w[manual organization date].each do |attribute|
|
97
|
-
value = ENV
|
97
|
+
value = ENV.fetch("RONN_#{attribute.upcase}", nil)
|
98
98
|
next if value.nil? || value.empty?
|
99
99
|
|
100
100
|
options[attribute] = value
|
@@ -135,11 +135,10 @@ ARGV.options do |argv|
|
|
135
135
|
argv.on('-v', '--version') do
|
136
136
|
require 'ronn'
|
137
137
|
if Ronn.release?
|
138
|
-
printf "
|
138
|
+
printf "ronn v%s (Ronn-NG)\n", Ronn::VERSION
|
139
139
|
else
|
140
|
-
printf "
|
140
|
+
printf "ronn v%s (rev %s) (Ronn-NG)\n", Ronn::VERSION, Ronn::REV
|
141
141
|
end
|
142
|
-
printf "http://github.com/apjanke/ronn-ng/tree/%s\n", Ronn.revision
|
143
142
|
exit 0
|
144
143
|
end
|
145
144
|
argv.on_tail('--help') { usage; exit 0 }
|
@@ -241,7 +240,7 @@ documents.each do |doc|
|
|
241
240
|
end
|
242
241
|
end
|
243
242
|
|
244
|
-
#
|
243
|
+
# write index.txt files
|
245
244
|
|
246
245
|
if write_index
|
247
246
|
indexes = documents.map(&:index).uniq
|
data/lib/ronn/document.rb
CHANGED
@@ -258,7 +258,7 @@ module Ronn
|
|
258
258
|
# Convert the document to HTML and return the result as a string.
|
259
259
|
# The returned string is a complete HTML document.
|
260
260
|
def to_html
|
261
|
-
layout = ENV
|
261
|
+
layout = ENV.fetch('RONN_LAYOUT', nil)
|
262
262
|
layout_path = nil
|
263
263
|
if layout
|
264
264
|
layout_path = File.expand_path(layout)
|
@@ -438,7 +438,7 @@ module Ronn
|
|
438
438
|
"<h1>#{title}</h1>"
|
439
439
|
elsif name
|
440
440
|
"<h2>NAME</h2>\n" \
|
441
|
-
|
441
|
+
"<p class='man-name'>\n <code>#{name}</code>" +
|
442
442
|
(tagline ? " - <span class='man-whatis'>#{tagline}</span>\n" : "\n") +
|
443
443
|
"</p>\n"
|
444
444
|
end
|
data/lib/ronn/roff.rb
CHANGED
@@ -142,7 +142,7 @@ module Ronn
|
|
142
142
|
# HACK: strip an initial \n to avoid extra spacing
|
143
143
|
if node.children && node.children[0].text?
|
144
144
|
text = node.children[0].to_s
|
145
|
-
node.children[0].replace(text[1
|
145
|
+
node.children[0].replace(text[1..]) if text.start_with? "\n"
|
146
146
|
end
|
147
147
|
inline_filter(node.children)
|
148
148
|
macro 'fi'
|
@@ -356,15 +356,15 @@ module Ronn
|
|
356
356
|
end
|
357
357
|
|
358
358
|
def quote(text)
|
359
|
-
"\"#{text.gsub(
|
359
|
+
"\"#{text.gsub('"', '\\"')}\""
|
360
360
|
end
|
361
361
|
|
362
362
|
# write text to output buffer
|
363
363
|
def write(text)
|
364
364
|
return if text.nil? || text.empty?
|
365
365
|
# lines cannot start with a '.' or "'". insert zero-width character before.
|
366
|
-
text = text.gsub(
|
367
|
-
text = text.gsub(
|
366
|
+
text = text.gsub("\n\\.", "\n\\\\&\\.")
|
367
|
+
text = text.gsub("\n'", "\n\\&\\'")
|
368
368
|
buf_ends_in_newline = @buf.last && @buf.last[-1] == "\n"
|
369
369
|
@buf << '\&' if text[0, 2] == '\.' && buf_ends_in_newline
|
370
370
|
@buf << '\&' if text[0, 1] == "'" && buf_ends_in_newline
|
data/lib/ronn/template.rb
CHANGED
data/lib/ronn.rb
CHANGED
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/
|
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,16 +56,16 @@
|
|
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>
|
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>
|
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">
|
68
|
+
<a class='man-ref' href="https://daringfireball.net/projects/markdown/syntax">Markdown syntax</a>,
|
69
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>,
|
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.
|
3
|
-
.TH "RONN\-FORMAT" "7" "
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre6
|
3
|
+
.TH "RONN\-FORMAT" "7" "January 2024" "Ronn-NG 0.10.1.pre6" "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
|
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\.
|
data/man/ronn-format.7.ronn
CHANGED
@@ -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
|
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.
|
3
|
-
.TH "RONN" "1" "January
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre6
|
3
|
+
.TH "RONN" "1" "January 2024" "Ronn-NG 0.10.1.pre6" "Ronn Manual"
|
4
4
|
.SH "NAME"
|
5
5
|
\fBronn\fR \- convert markdown files to manpages
|
6
6
|
.SH "SYNOPSIS"
|
data/ronn-ng.gemspec
CHANGED
@@ -1,10 +1,11 @@
|
|
1
1
|
Gem::Specification.new do |s|
|
2
2
|
s.name = 'ronn-ng'
|
3
|
-
s.version = '0.10.1.
|
4
|
-
|
3
|
+
s.version = '0.10.1.pre6'
|
4
|
+
# We target Ruby 2.7+ for test & deploy, plus nokogiri 1.14.3+ need Ruby 2.7
|
5
|
+
s.required_ruby_version = '>= 2.7'
|
5
6
|
|
6
7
|
s.summary = 'Builds man pages from Markdown'
|
7
|
-
s.description = 'Ronn-NG builds manuals in
|
8
|
+
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
9
|
s.homepage = 'https://github.com/apjanke/ronn-ng'
|
9
10
|
s.license = 'MIT'
|
10
11
|
|
@@ -12,15 +13,16 @@ Gem::Specification.new do |s|
|
|
12
13
|
s.email = 'floss@apjanke.net'
|
13
14
|
|
14
15
|
s.metadata = {
|
15
|
-
'bug_tracker_uri'
|
16
|
-
'source_code_uri'
|
17
|
-
'changelog_uri'
|
16
|
+
'bug_tracker_uri' => 'https://github.com/apjanke/ronn-ng/issues',
|
17
|
+
'source_code_uri' => 'https://github.com/apjanke/ronn-ng',
|
18
|
+
'changelog_uri' => 'https://github.com/apjanke/ronn-ng/blob/main/CHANGELOG.md',
|
19
|
+
'rubygems_mfa_required' => 'true'
|
18
20
|
}
|
19
21
|
|
20
22
|
# = MANIFEST =
|
21
23
|
s.files = %w[
|
22
24
|
AUTHORS
|
23
|
-
|
25
|
+
CHANGELOG.md
|
24
26
|
INSTALLING.md
|
25
27
|
LICENSE.txt
|
26
28
|
README.md
|
@@ -55,18 +57,22 @@ Gem::Specification.new do |s|
|
|
55
57
|
# = MANIFEST =
|
56
58
|
|
57
59
|
s.executables = ['ronn']
|
58
|
-
s.test_files = s.files.select { |path| path =~ /^test\/.*_test.rb/ }
|
59
60
|
|
60
61
|
s.extra_rdoc_files = %w[LICENSE.txt AUTHORS]
|
61
|
-
s.add_dependency 'kramdown',
|
62
|
-
s.add_dependency 'kramdown-parser-gfm',
|
63
|
-
s.add_dependency 'mustache',
|
64
|
-
|
65
|
-
s.
|
66
|
-
|
67
|
-
s.add_development_dependency '
|
68
|
-
s.add_development_dependency '
|
69
|
-
|
62
|
+
s.add_dependency 'kramdown', ['~> 2', '>= 2.1']
|
63
|
+
s.add_dependency 'kramdown-parser-gfm', ['~> 1', '>= 1.0.1']
|
64
|
+
s.add_dependency 'mustache', ['~> 1']
|
65
|
+
# nokogiri <= 1.14.2 mishandle tag names with ":" in them (see #102)
|
66
|
+
s.add_dependency 'nokogiri', ['~> 1', '>= 1.14.3']
|
67
|
+
# rack < 2.2.3 have security vulns
|
68
|
+
s.add_development_dependency 'rack', ['~> 2', '>= 2.2.3']
|
69
|
+
s.add_development_dependency 'rake', ['~> 13', '>= 13.0.3']
|
70
|
+
# just a guess based on what I used to use
|
71
|
+
s.add_development_dependency 'rubocop', ['~> 1', '>= 1.25.1']
|
72
|
+
s.add_development_dependency 'rubocop-rake', ['~> 0']
|
73
|
+
# sinatra < 2.2.3 have security vulns
|
74
|
+
s.add_development_dependency 'sinatra', ['~> 2', '>= 2.2.3']
|
75
|
+
s.add_development_dependency 'test-unit', ['~> 3', '>= 3.2.7']
|
70
76
|
|
71
77
|
s.rdoc_options = ['--line-numbers', '--inline-source', '--title', 'Ronn']
|
72
78
|
s.require_paths = %w[lib]
|
metadata
CHANGED
@@ -1,20 +1,23 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ronn-ng
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.10.1.
|
4
|
+
version: 0.10.1.pre6
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Andrew Janke
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-01-06 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
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '2'
|
20
|
+
- - ">="
|
18
21
|
- !ruby/object:Gem::Version
|
19
22
|
version: '2.1'
|
20
23
|
type: :runtime
|
@@ -22,69 +25,72 @@ dependencies:
|
|
22
25
|
version_requirements: !ruby/object:Gem::Requirement
|
23
26
|
requirements:
|
24
27
|
- - "~>"
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '2'
|
30
|
+
- - ">="
|
25
31
|
- !ruby/object:Gem::Version
|
26
32
|
version: '2.1'
|
27
33
|
- !ruby/object:Gem::Dependency
|
28
34
|
name: kramdown-parser-gfm
|
29
35
|
requirement: !ruby/object:Gem::Requirement
|
30
36
|
requirements:
|
37
|
+
- - "~>"
|
38
|
+
- !ruby/object:Gem::Version
|
39
|
+
version: '1'
|
31
40
|
- - ">="
|
32
41
|
- !ruby/object:Gem::Version
|
33
42
|
version: 1.0.1
|
34
|
-
- - "<"
|
35
|
-
- !ruby/object:Gem::Version
|
36
|
-
version: '1.2'
|
37
43
|
type: :runtime
|
38
44
|
prerelease: false
|
39
45
|
version_requirements: !ruby/object:Gem::Requirement
|
40
46
|
requirements:
|
47
|
+
- - "~>"
|
48
|
+
- !ruby/object:Gem::Version
|
49
|
+
version: '1'
|
41
50
|
- - ">="
|
42
51
|
- !ruby/object:Gem::Version
|
43
52
|
version: 1.0.1
|
44
|
-
- - "<"
|
45
|
-
- !ruby/object:Gem::Version
|
46
|
-
version: '1.2'
|
47
53
|
- !ruby/object:Gem::Dependency
|
48
54
|
name: mustache
|
49
55
|
requirement: !ruby/object:Gem::Requirement
|
50
56
|
requirements:
|
51
57
|
- - "~>"
|
52
58
|
- !ruby/object:Gem::Version
|
53
|
-
version: '1
|
59
|
+
version: '1'
|
54
60
|
type: :runtime
|
55
61
|
prerelease: false
|
56
62
|
version_requirements: !ruby/object:Gem::Requirement
|
57
63
|
requirements:
|
58
64
|
- - "~>"
|
59
65
|
- !ruby/object:Gem::Version
|
60
|
-
version: '1
|
66
|
+
version: '1'
|
61
67
|
- !ruby/object:Gem::Dependency
|
62
68
|
name: nokogiri
|
63
69
|
requirement: !ruby/object:Gem::Requirement
|
64
70
|
requirements:
|
65
71
|
- - "~>"
|
66
72
|
- !ruby/object:Gem::Version
|
67
|
-
version: '1
|
73
|
+
version: '1'
|
68
74
|
- - ">="
|
69
75
|
- !ruby/object:Gem::Version
|
70
|
-
version: 1.
|
76
|
+
version: 1.14.3
|
71
77
|
type: :runtime
|
72
78
|
prerelease: false
|
73
79
|
version_requirements: !ruby/object:Gem::Requirement
|
74
80
|
requirements:
|
75
81
|
- - "~>"
|
76
82
|
- !ruby/object:Gem::Version
|
77
|
-
version: '1
|
83
|
+
version: '1'
|
78
84
|
- - ">="
|
79
85
|
- !ruby/object:Gem::Version
|
80
|
-
version: 1.
|
86
|
+
version: 1.14.3
|
81
87
|
- !ruby/object:Gem::Dependency
|
82
88
|
name: rack
|
83
89
|
requirement: !ruby/object:Gem::Requirement
|
84
90
|
requirements:
|
85
91
|
- - "~>"
|
86
92
|
- !ruby/object:Gem::Version
|
87
|
-
version: '2
|
93
|
+
version: '2'
|
88
94
|
- - ">="
|
89
95
|
- !ruby/object:Gem::Version
|
90
96
|
version: 2.2.3
|
@@ -94,7 +100,7 @@ dependencies:
|
|
94
100
|
requirements:
|
95
101
|
- - "~>"
|
96
102
|
- !ruby/object:Gem::Version
|
97
|
-
version: '2
|
103
|
+
version: '2'
|
98
104
|
- - ">="
|
99
105
|
- !ruby/object:Gem::Version
|
100
106
|
version: 2.2.3
|
@@ -104,75 +110,95 @@ dependencies:
|
|
104
110
|
requirements:
|
105
111
|
- - "~>"
|
106
112
|
- !ruby/object:Gem::Version
|
107
|
-
version: '
|
113
|
+
version: '13'
|
108
114
|
- - ">="
|
109
115
|
- !ruby/object:Gem::Version
|
110
|
-
version:
|
116
|
+
version: 13.0.3
|
111
117
|
type: :development
|
112
118
|
prerelease: false
|
113
119
|
version_requirements: !ruby/object:Gem::Requirement
|
114
120
|
requirements:
|
115
121
|
- - "~>"
|
116
122
|
- !ruby/object:Gem::Version
|
117
|
-
version: '
|
123
|
+
version: '13'
|
118
124
|
- - ">="
|
119
125
|
- !ruby/object:Gem::Version
|
120
|
-
version:
|
126
|
+
version: 13.0.3
|
121
127
|
- !ruby/object:Gem::Dependency
|
122
128
|
name: rubocop
|
123
129
|
requirement: !ruby/object:Gem::Requirement
|
124
130
|
requirements:
|
125
131
|
- - "~>"
|
126
132
|
- !ruby/object:Gem::Version
|
127
|
-
version: 1
|
133
|
+
version: '1'
|
134
|
+
- - ">="
|
135
|
+
- !ruby/object:Gem::Version
|
136
|
+
version: 1.25.1
|
128
137
|
type: :development
|
129
138
|
prerelease: false
|
130
139
|
version_requirements: !ruby/object:Gem::Requirement
|
131
140
|
requirements:
|
132
141
|
- - "~>"
|
133
142
|
- !ruby/object:Gem::Version
|
134
|
-
version: 1
|
143
|
+
version: '1'
|
144
|
+
- - ">="
|
145
|
+
- !ruby/object:Gem::Version
|
146
|
+
version: 1.25.1
|
147
|
+
- !ruby/object:Gem::Dependency
|
148
|
+
name: rubocop-rake
|
149
|
+
requirement: !ruby/object:Gem::Requirement
|
150
|
+
requirements:
|
151
|
+
- - "~>"
|
152
|
+
- !ruby/object:Gem::Version
|
153
|
+
version: '0'
|
154
|
+
type: :development
|
155
|
+
prerelease: false
|
156
|
+
version_requirements: !ruby/object:Gem::Requirement
|
157
|
+
requirements:
|
158
|
+
- - "~>"
|
159
|
+
- !ruby/object:Gem::Version
|
160
|
+
version: '0'
|
135
161
|
- !ruby/object:Gem::Dependency
|
136
162
|
name: sinatra
|
137
163
|
requirement: !ruby/object:Gem::Requirement
|
138
164
|
requirements:
|
139
165
|
- - "~>"
|
140
166
|
- !ruby/object:Gem::Version
|
141
|
-
version: '2
|
167
|
+
version: '2'
|
142
168
|
- - ">="
|
143
169
|
- !ruby/object:Gem::Version
|
144
|
-
version: 2.
|
170
|
+
version: 2.2.3
|
145
171
|
type: :development
|
146
172
|
prerelease: false
|
147
173
|
version_requirements: !ruby/object:Gem::Requirement
|
148
174
|
requirements:
|
149
175
|
- - "~>"
|
150
176
|
- !ruby/object:Gem::Version
|
151
|
-
version: '2
|
177
|
+
version: '2'
|
152
178
|
- - ">="
|
153
179
|
- !ruby/object:Gem::Version
|
154
|
-
version: 2.
|
180
|
+
version: 2.2.3
|
155
181
|
- !ruby/object:Gem::Dependency
|
156
182
|
name: test-unit
|
157
183
|
requirement: !ruby/object:Gem::Requirement
|
158
184
|
requirements:
|
159
185
|
- - "~>"
|
160
186
|
- !ruby/object:Gem::Version
|
161
|
-
version: '3
|
187
|
+
version: '3'
|
162
188
|
- - ">="
|
163
189
|
- !ruby/object:Gem::Version
|
164
|
-
version: 3.
|
190
|
+
version: 3.2.7
|
165
191
|
type: :development
|
166
192
|
prerelease: false
|
167
193
|
version_requirements: !ruby/object:Gem::Requirement
|
168
194
|
requirements:
|
169
195
|
- - "~>"
|
170
196
|
- !ruby/object:Gem::Version
|
171
|
-
version: '3
|
197
|
+
version: '3'
|
172
198
|
- - ">="
|
173
199
|
- !ruby/object:Gem::Version
|
174
|
-
version: 3.
|
175
|
-
description: Ronn-NG builds manuals in
|
200
|
+
version: 3.2.7
|
201
|
+
description: Ronn-NG builds manuals in Unix man page and HTML format from Markdown.
|
176
202
|
Ronn-NG is a modern, maintained fork of the original Ronn.
|
177
203
|
email: floss@apjanke.net
|
178
204
|
executables:
|
@@ -183,7 +209,7 @@ extra_rdoc_files:
|
|
183
209
|
- AUTHORS
|
184
210
|
files:
|
185
211
|
- AUTHORS
|
186
|
-
-
|
212
|
+
- CHANGELOG.md
|
187
213
|
- INSTALLING.md
|
188
214
|
- LICENSE.txt
|
189
215
|
- README.md
|
@@ -220,7 +246,8 @@ licenses:
|
|
220
246
|
metadata:
|
221
247
|
bug_tracker_uri: https://github.com/apjanke/ronn-ng/issues
|
222
248
|
source_code_uri: https://github.com/apjanke/ronn-ng
|
223
|
-
changelog_uri: https://github.com/apjanke/ronn-ng/blob/main/
|
249
|
+
changelog_uri: https://github.com/apjanke/ronn-ng/blob/main/CHANGELOG.md
|
250
|
+
rubygems_mfa_required: 'true'
|
224
251
|
post_install_message:
|
225
252
|
rdoc_options:
|
226
253
|
- "--line-numbers"
|
@@ -233,14 +260,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
233
260
|
requirements:
|
234
261
|
- - ">="
|
235
262
|
- !ruby/object:Gem::Version
|
236
|
-
version: '2.
|
263
|
+
version: '2.7'
|
237
264
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
238
265
|
requirements:
|
239
266
|
- - ">"
|
240
267
|
- !ruby/object:Gem::Version
|
241
268
|
version: 1.3.1
|
242
269
|
requirements: []
|
243
|
-
rubygems_version: 3.
|
270
|
+
rubygems_version: 3.1.6
|
244
271
|
signing_key:
|
245
272
|
specification_version: 4
|
246
273
|
summary: Builds man pages from Markdown
|