ronn-ng 0.10.0.pre.SNAPSHOT → 0.10.1.pre2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (71) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHORS +11 -7
  3. data/CHANGES +12 -1
  4. data/INSTALLING.md +29 -27
  5. data/LICENSE.txt +1 -1
  6. data/README.md +48 -32
  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 +8 -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 +7 -7
  16. data/man/ronn.1 +25 -25
  17. data/man/ronn.1.ronn +7 -6
  18. data/ronn-ng.gemspec +6 -59
  19. metadata +19 -70
  20. data/Gemfile +0 -2
  21. data/test/angle_bracket_syntax.html +0 -27
  22. data/test/angle_bracket_syntax.ronn +0 -22
  23. data/test/backticks.html +0 -14
  24. data/test/backticks.ronn +0 -10
  25. data/test/basic_document.html +0 -8
  26. data/test/basic_document.ronn +0 -4
  27. data/test/circumflexes.ronn +0 -1
  28. data/test/code_blocks.ronn +0 -41
  29. data/test/contest.rb +0 -70
  30. data/test/custom_title_document.html +0 -6
  31. data/test/custom_title_document.ronn +0 -5
  32. data/test/definition_list_syntax.html +0 -25
  33. data/test/definition_list_syntax.roff +0 -19
  34. data/test/definition_list_syntax.ronn +0 -18
  35. data/test/dots_at_line_start_test.roff +0 -19
  36. data/test/dots_at_line_start_test.ronn +0 -12
  37. data/test/ellipses.roff +0 -7
  38. data/test/ellipses.ronn +0 -7
  39. data/test/entity_encoding_test.html +0 -42
  40. data/test/entity_encoding_test.roff +0 -51
  41. data/test/entity_encoding_test.ronn +0 -34
  42. data/test/index.txt +0 -8
  43. data/test/markdown_syntax.html +0 -954
  44. data/test/markdown_syntax.roff +0 -907
  45. data/test/markdown_syntax.ronn +0 -881
  46. data/test/middle_paragraph.html +0 -14
  47. data/test/middle_paragraph.roff +0 -9
  48. data/test/middle_paragraph.ronn +0 -10
  49. data/test/missing_spaces.roff +0 -7
  50. data/test/missing_spaces.ronn +0 -2
  51. data/test/nested_list.ronn +0 -19
  52. data/test/nested_list_with_code.html +0 -14
  53. data/test/nested_list_with_code.roff +0 -11
  54. data/test/nested_list_with_code.ronn +0 -6
  55. data/test/ordered_list.html +0 -28
  56. data/test/ordered_list.roff +0 -25
  57. data/test/ordered_list.ronn +0 -21
  58. data/test/page.with.periods.in.name.5.ronn +0 -4
  59. data/test/pre_block_with_quotes.roff +0 -8
  60. data/test/pre_block_with_quotes.ronn +0 -6
  61. data/test/section_reference_links.html +0 -16
  62. data/test/section_reference_links.roff +0 -7
  63. data/test/section_reference_links.ronn +0 -12
  64. data/test/tables.ronn +0 -24
  65. data/test/test_ronn.rb +0 -124
  66. data/test/test_ronn_document.rb +0 -186
  67. data/test/test_ronn_index.rb +0 -73
  68. data/test/titleless_document.html +0 -9
  69. data/test/titleless_document.ronn +0 -3
  70. data/test/underline_spacing_test.roff +0 -13
  71. data/test/underline_spacing_test.ronn +0 -11
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 42d3c988ea961f9b89073f5534e6c0fc721c2f951e0a3d4e14f74987bab263db
4
- data.tar.gz: ef7745fc686d7ba4de2bfa94f9071e05a675a18389a064cf651970976ba09e0f
3
+ metadata.gz: 19392851711576551758ca8fca8235a0a9784acd846e560e3808336aa8912d97
4
+ data.tar.gz: 8854f5df3e52079e811a4499262c5dd4a3127e309ec6efa2f2ddc35a041a6a1c
5
5
  SHA512:
6
- metadata.gz: 3a065288a7f12e64f33c1c5fea974a1954e21b0ea56b96f934fbad5f1570ee5b71716d10feb9b28cf9cd894ef4a185054889fa1c698f249595b1e8abbc8f24f9
7
- data.tar.gz: '0338fdc307af4380e99127bd9e137c53e6ea7c9ddb7e719616667602de4fd7cae856c7099a3b9053cdc02c4083b10feae666f87e40688016782433f8663d1cc8'
6
+ metadata.gz: c4e6ea4b5d05c5272714cc98cb34e83beb3b8a3a695c455d1d0c64ade25b43db134d45ea5b7294524bf7650d83127469ac2e45c401d6425f0242a5ed68761b39
7
+ data.tar.gz: 1a4846f9941112800514d6b418983278242fe7abb4f97b5ebd908cfe47a4be9fb231e782ef103fa73b12aaf6017528347522d8585067d4d4c89fb53378f4ac3a
data/AUTHORS CHANGED
@@ -1,8 +1,12 @@
1
- # This is a list of people who have contributed code or ideas to ronn -- for
2
- # copyright purposes or whatever.
1
+ # Ronn-NG Authors
3
2
 
4
- Ryan Tomayko <http://github.com/rtomayko>
5
- Chris Wanstrath <http://github.com/defunkt>
6
- Suraj N. Kurapati <http://github.com/sunaku>
7
- Hallison Batista <http://github.com/hallison>
8
- Andrew Janke <http://github.com/apjanke>
3
+ This is a list of people who have contributed code or ideas to Ronn and Ronn-NG.
4
+
5
+ Ryan Tomayko (original Ronn author) <https://github.com/rtomayko>
6
+ Andrew Janke (main Ronn-NG author) <https://github.com/apjanke>
7
+
8
+ Hallison Batista <https://github.com/hallison>
9
+ Suraj N. Kurapati <https://github.com/sunaku>
10
+ Takuya Noguchi <https://github.com/tnir>
11
+ Deivid Rodriguez <https://github.com/deivid-rodriguez>
12
+ Chris Wanstrath <https://github.com/defunkt>
data/CHANGES CHANGED
@@ -1,14 +1,25 @@
1
1
  Ronn-NG CHANGES
2
2
  ===============
3
3
 
4
- Version 0.10.0 (2020 Oct 22)
4
+ Version 0.10.1 (in progress)
5
5
  ----------------------------
6
6
 
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.
9
+
7
10
  * Switch to GitHub Flavored Markdown, fixing code block rendering (<https://github.com/apjanke/ronn-ng/pull/53>)
8
11
  * Revert `\[ci]` back to `\(bu)` (<https://github.com/apjanke/ronn-ng/pull/51>)
9
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>)
10
16
  * Bump to mustache 1.x
11
17
 
18
+ Version 0.10.0 (never)
19
+ ---------------------------
20
+
21
+ Doesn't exist due to a RubyGems publishing mistake.
22
+
12
23
  Version 0.9.1 (2020 Apr 09)
13
24
  ---------------------------
14
25
 
data/INSTALLING.md CHANGED
@@ -1,5 +1,4 @@
1
- Ronn-NG Installation
2
- ====================
1
+ # Ronn-NG Installation
3
2
 
4
3
  ## Installation Process
5
4
 
@@ -8,7 +7,7 @@ Ronn-NG Installation
8
7
  The best way to install Ronn-NG is with a package manager. This is currently
9
8
  only supported on macOS, with [Homebrew](http://brew.sh). To install with `brew`:
10
9
 
11
- ```
10
+ ```bash
12
11
  brew tap apjanke/ronn-ng
13
12
  brew install ronn-ng
14
13
  ```
@@ -18,7 +17,7 @@ brew install ronn-ng
18
17
  Ronn-NG is distributed as a gem package, which can be used if you don't have
19
18
  a supported package manager. Install with rubygems:
20
19
 
21
- ```
20
+ ```bash
22
21
  gem install ronn-ng
23
22
  ronn --help
24
23
  ```
@@ -32,7 +31,7 @@ completion directories pointing at the files in the installed gem.
32
31
 
33
32
  In Zsh, you can do something like this:
34
33
 
35
- ```
34
+ ```bash
36
35
  ronn_dist_dir=$(dirname $(dirname $(gem which ronn-ng)))
37
36
  ronn_zsh_dir="$ronn_dist_dir/completion/zsh"
38
37
  ln -s "$ronn_zsh_dir/_ronn" /usr/local/share/zsh/site-functions
@@ -40,7 +39,7 @@ ln -s "$ronn_zsh_dir/_ronn" /usr/local/share/zsh/site-functions
40
39
 
41
40
  In Bash, something like this:
42
41
 
43
- ```
42
+ ```bash
44
43
  ronn_dist_dir=$(dirname $(dirname $(gem which ronn-ng)))
45
44
  ronn_bash_dir="$ronn_dist_dir/completion/bash"
46
45
  ln -s "$ronn_bash_dir/ronn" /usr/local/etc/bash_completion.d
@@ -53,46 +52,49 @@ to be a limitation of the `gem` installation mechanism.
53
52
  If that `gem which` stuff doesn't work for you, you can `gem install gem-path`
54
53
  and use `gem path ronn-ng` instead.
55
54
 
56
-
57
55
  ## Building from Source
58
56
 
59
- Hacking? Install Ronn-NG from source.
57
+ Hacking on Ronn? Install Ronn-NG from source.
60
58
 
61
- Clone the git repository and put ronn/bin on your PATH:
59
+ Clone the git repository and put `ronn/bin` on your PATH:
62
60
 
63
- ```
64
- git clone git://github.com/apjanke/ronn-ng
65
- PATH=$(pwd)/ronn-ng/bin:$PATH
61
+ ```bash
62
+ git clone https://github.com/apjanke/ronn-ng
63
+ PATH="$(pwd)/ronn-ng/bin:$PATH"
66
64
  ```
67
65
 
68
- The following gems are required for ronn-ng development:
69
- * nokogiri
70
- * mustache
71
- * kramdown
72
- * rubocop
73
- * sinatra
74
- * rack
75
- * rake
76
- * test-unit
66
+ The following gems are required for Ronn-NG development:
77
67
 
78
- ```
79
- gem install nokogiri mustache kramdown rubocop sinatra rack rake test-unit
80
- ```
68
+ * nokogiri
69
+ * mustache
70
+ * kramdown
71
+ * rubocop
72
+ * sinatra
73
+ * rack
74
+ * rake
75
+ * test-unit
81
76
 
82
- Or install them with bundler using the project's gem definition:
77
+ You can install them locally in your ronn-ng repo with bundler using the project's gem definition:
83
78
 
84
- ```
79
+ ```bash
85
80
  bundle install --with development
86
81
  ```
87
82
 
83
+ Or install them "globally" using gem:
84
+
85
+ ```bash
86
+ gem install nokogiri mustache kramdown rubocop sinatra rack rake test-unit
87
+ ```
88
+
88
89
  Then you should be able to make changes directly to your cloned repo and have
89
90
  them be reflected in your active `ronn` command.
90
91
 
91
92
  ## Legacy Versions
92
93
 
93
94
  Historical Ronn tarballs available at [the original Ronn repo](http://github.com/rtomayko/ronn/downloads).
95
+ This is the originall Ronn project that Ronn-NG was forked from.
94
96
 
95
- ```
97
+ ```brew
96
98
  curl -L http://github.com/rtomayko/ronn/downloads/0.6.6 | tar xvzf -
97
99
  cd rtomayko-r*
98
100
  ruby setup.rb
data/LICENSE.txt CHANGED
@@ -1,7 +1,7 @@
1
1
  The MIT License
2
2
 
3
3
  Copyright (C) 2009 Ryan Tomayko <tomayko.com/about>
4
- Copyright (C) 2018, 2019 Andrew Janke <apjanke.net>
4
+ Copyright (C) 2018, 2019, 2020, 2022 Andrew Janke <apjanke.net>
5
5
 
6
6
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
7
7
 
data/README.md CHANGED
@@ -14,15 +14,15 @@ detail.
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/master/man/ronn.1.ronn),
19
- [roff output](http://github.com/apjanke/ronn-ng/blob/master/man/ronn.1)
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)
20
20
 
21
- * [ronn-format(7)](http://rtomayko.github.com/ronn/ronn-format.7) -
22
- [source file](http://github.com/apjanke/ronn-ng/blob/master/man/ronn-format.7.ronn),
23
- [roff output](http://github.com/apjanke/ronn-ng/blob/master/man/ronn-format.7)
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)
24
24
 
25
- [1]: http://github.com/apjanke/ronn-ng/tree/master/man
25
+ [1]: http://github.com/apjanke/ronn-ng/tree/main/man
26
26
 
27
27
  As an alternative, you might want to check out [pandoc](http://johnmacfarlane.net/pandoc/) which can also convert markdown into roff manual pages.
28
28
 
@@ -30,14 +30,14 @@ As an alternative, you might want to check out [pandoc](http://johnmacfarlane.ne
30
30
 
31
31
  Install with Homebrew on macOS:
32
32
 
33
- ```
33
+ ```bash
34
34
  brew tap apjanke/ronn-ng
35
35
  brew install ronn-ng
36
36
  ```
37
37
 
38
38
  Install with `gem` anywhere that supports it:
39
39
 
40
- ```
40
+ ```bash
41
41
  gem install ronn-ng
42
42
  ```
43
43
 
@@ -47,74 +47,90 @@ See [INSTALLING.md](INSTALLING.md) for details on other systems and installation
47
47
 
48
48
  Build roff and HTML output files for one or more input files:
49
49
 
50
- $ ronn man/ronn.5.ronn
51
- roff: man/ronn.5
52
- html: man/ronn.5.html
50
+ ```bash
51
+ $ ronn man/ronn.5.ronn
52
+ roff: man/ronn.5
53
+ html: man/ronn.5.html
54
+ ```
53
55
 
54
56
  Generate only a standalone HTML version of one or more files:
55
57
 
56
- $ ronn --html man/markdown.5.ronn
57
- html: man/markdown.5.html
58
+ ```bash
59
+ $ ronn --html man/markdown.5.ronn
60
+ html: man/markdown.5.html
61
+ ```
58
62
 
59
63
  Build roff versions of all ronn files in a directory:
60
64
 
61
- $ ronn --roff man/*.ronn
65
+ ```bash
66
+ $ ronn --roff man/*.ronn
67
+ ```
62
68
 
63
69
  View a ronn file as if it were a manpage without building intermediate files:
64
70
 
65
- $ ronn --man man/markdown.5.ronn
71
+ ```bash
72
+ $ ronn --man man/markdown.5.ronn
73
+ ```
66
74
 
67
75
  View roff output with man(1):
68
76
 
69
- $ man man/ronn.5
77
+ ```bash
78
+ $ man man/ronn.5
79
+ ```
70
80
 
71
81
  The [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) manual page includes
72
82
  comprehensive documentation on `ronn` command line options.
73
83
 
74
84
  ## Background
75
85
 
76
- Some think Unix manual pages are a poor and outdated form of documentation. I
77
- disagree:
86
+ Some think Unix man pages are a poor and outdated form of documentation. Ronn-NG
87
+ disagrees:
78
88
 
79
- - Manpages follow a well defined structure that's immediately familiar. This
89
+ * Manpages follow a well defined structure that's immediately familiar. This
80
90
  gives developers a starting point when documenting new tools, libraries, and
81
91
  formats.
82
92
 
83
- - Manpages get to the point. Because they're written in an inverted style, with
93
+ * Manpages get to the point. Because they're written in an inverted style, with
84
94
  a SYNOPSIS section followed by additional detail, prose and references to
85
95
  other sources of information, manpages provide the best of both cheat sheet
86
96
  and reference style documentation.
87
97
 
88
- - Historically, manpages use an extremely -- unbelievably -- limited set of
98
+ * Historically, manpages use an extremely unbelievably limited set of
89
99
  text formatting capabilities. You get a couple of headings, lists, bold,
90
100
  underline and no more. This is a feature.
91
101
 
92
- - Although two levels of section hierarchy are technically supported, most
102
+ * Although two levels of section hierarchy are technically supported, most
93
103
  manpages use only a single level. Unwieldy document hierarchies complicate
94
104
  otherwise good documentation. Remember that Feynman covered all of physics
95
- -- heavenly bodies through QED -- with only two levels of document hierarchy
105
+ heavenly bodies through QED with only two levels of document hierarchy
96
106
  (_The Feynman Lectures on Physics_, 1970).
97
107
 
98
- - The classical terminal manpage display is typographically well thought out.
108
+ * The classical terminal manpage display is typographically well thought out.
99
109
  Big bold section headings, justified monospace text, nicely indented
100
110
  paragraphs, intelligently aligned definition lists, and an informational
101
111
  header and footer.
102
112
 
103
- - Manpages have a simple referencing syntax; e.g., sh(1), fork(2), markdown(7).
113
+ * Manpages have a simple referencing syntax; e.g., sh(1), fork(2), markdown(7).
104
114
  HTML versions can use this to generate links between pages.
105
115
 
106
116
  Unfortunately, figuring out how to create a manpage is a fairly tedious process.
107
117
  The roff/mandoc/mdoc macro languages are highly extensible, fractured between
108
- multiple dialects, and include a bunch of device specific stuff irrelevant to
109
- modern publishing tools.
118
+ multiple dialects, and include a bunch of device-specific stuff irrelevant to
119
+ modern publishing tools. Ronn aims to solve that problem.
110
120
 
111
121
  ## Requirements
112
122
 
113
- Ruby 2.3 or newer.
123
+ Ronn-NG requires Ruby 2.4 or newer.
124
+
125
+ Ruby 3.x support is a work in progress as of Ronn-NG 0.10.1 (December 2022).
126
+
127
+ If you are installing Ronn-NG as a standalone program (the usual way to use it), it
128
+ includes all its Ruby libraries, and has no other dependencies. If you are using
129
+ Ronn-NG as a gem or other library, it requires gems as listed in `ronn-ng.gemspec`.
114
130
 
115
131
  ## Project Management
116
132
 
117
- The project home page is at https://github.com/apjanke/ronn-ng. Bug reports,
133
+ The project home page is at <https://github.com/apjanke/ronn-ng>. Bug reports,
118
134
  feature requests, and patch submissions are welcome.
119
135
 
120
136
  Ronn-NG was forked from the original Ronn project in 2018 after Ronn
@@ -127,10 +143,10 @@ MIT License.
127
143
 
128
144
  Ronn is Copyright (C) 2010 [Ryan Tomayko](http://tomayko.com/about).
129
145
 
130
- New Ronn-NG material is Copyright (C) 2018, 2019 [Andrew Janke](https://apjanke.net).
146
+ New Ronn-NG material is Copyright (C) 2018-2022 [Andrew Janke](https://apjanke.net) and other contributors.
131
147
 
132
148
  See the file LICENSE.txt for information of licensing and distribution.
133
149
 
134
150
  ## Build Status
135
151
 
136
- ![Travis build status](https://travis-ci.com/apjanke/ronn-ng.svg?branch=master)
152
+ ![Travis build status](https://travis-ci.com/apjanke/ronn-ng.svg?branch=main)
data/Rakefile CHANGED
@@ -69,7 +69,7 @@ end
69
69
  task :rev do
70
70
  rev = ENV['REV'] || `git describe --tags`.chomp
71
71
  data = File.read('lib/ronn.rb')
72
- data.gsub!(/^( *)REV *=.*/, "\\1REV = '#{rev}'")
72
+ data.gsub!(/^( *)REV *=.*/, "\\1REV = '#{rev.sub(/\Av/, '')}'.freeze")
73
73
  File.open('lib/ronn.rb', 'wb') { |fd| fd.write(data) }
74
74
  puts "revision: #{rev}"
75
75
  puts "version: #{`ruby -Ilib -rronn -e 'puts Ronn::VERSION'`}"
data/bin/ronn CHANGED
@@ -87,7 +87,7 @@ options = {}
87
87
  write_index = false
88
88
  styles = %w[man]
89
89
  groff = 'groff -Wall -mtty-char -mandoc -Tascii -t'
90
- pager = ENV['MANPAGER'] || ENV['PAGER'] || 'more -is'
90
+ pager = ENV['MANPAGER'] || ENV['PAGER'] || 'more -s'
91
91
  output_dir = nil
92
92
 
93
93
  ##
data/lib/ronn/document.rb CHANGED
@@ -179,11 +179,14 @@ module Ronn
179
179
  end
180
180
 
181
181
  # The date the man page was published. If not set explicitly,
182
- # this is the file's modified time or, if no file is given,
182
+ # it first checks for "SOURCE_DATE_EPOCH" to support reproducible
183
+ # builds, then the file's modified time or, if no file is given,
183
184
  # the current time. Center displayed in the document footer.
184
185
  def date
185
186
  return @date if @date
186
187
 
188
+ return Time.at(ENV['SOURCE_DATE_EPOCH'].to_i).gmtime if ENV['SOURCE_DATE_EPOCH']
189
+
187
190
  return File.mtime(path) if File.exist?(path)
188
191
 
189
192
  Time.now
data/lib/ronn/roff.rb CHANGED
@@ -111,6 +111,10 @@ module Ronn
111
111
  macro 'SH', quote(escape(node.inner_html))
112
112
  when 'h3'
113
113
  macro 'SS', quote(escape(node.inner_html))
114
+ when 'h4', 'h5', 'h6'
115
+ # Ronn discourages use of this many heading levels, but if they are used,
116
+ # we should make them legible instead of ignoring them.
117
+ macro 'SS', quote(escape(node.inner_html))
114
118
 
115
119
  when 'p'
116
120
  prev = previous(node)
@@ -250,10 +254,14 @@ module Ronn
250
254
  text = node.to_html.dup
251
255
  write escape(text)
252
256
 
257
+ elsif node.comment?
258
+ # ignore HTML comments
259
+
253
260
  elsif node.elem?
254
261
  case node.name
255
262
  when 'span'
256
263
  inline_filter(node.children)
264
+
257
265
  when 'code'
258
266
  if child_of?(node, 'pre')
259
267
  inline_filter(node.children)
@@ -1,7 +1,7 @@
1
1
  <!DOCTYPE html>
2
2
  <html>
3
3
  <head>
4
- <meta http-equiv='content-type' content='text/html;charset=utf8'>
4
+ <meta http-equiv='content-type' content='text/html;charset=utf-8'>
5
5
  <meta name='generator' content='{{ generator }}'>
6
6
  <title>{{ title }}</title>
7
7
  {{{ stylesheet_tags }}}
data/lib/ronn.rb CHANGED
@@ -22,15 +22,15 @@ module Ronn
22
22
 
23
23
  # A semantic version number based on the git revision. The third element
24
24
  # of the version is incremented by the commit offset, such that version
25
- # 0.6.6-5-gdacd74b => 0.6.11
25
+ # v0.6.6-5-gdacd74b => 0.6.11
26
26
  def self.version
27
- ver = revision[/^[0-9.-]+/].split(/[.-]/).map(&:to_i)
27
+ ver = revision.sub(/\Av/, '')[/^[0-9.-]+/].split(/[.-]/).map(&:to_i)
28
28
  ver[2] += ver.pop while ver.size > 3
29
29
  ver.join('.')
30
30
  end
31
31
 
32
32
  # The string revision as reported by: git-describe --tags. This is just the
33
- # tag name when a tag references the HEAD commit (e.g. 0.6.25). When the HEAD
33
+ # tag name when a tag references the HEAD commit (e.g. v0.6.25). When the HEAD
34
34
  # commit is not tagged, this is a "<tag>-<offset>-<sha1>" string:
35
35
  # <tag> - closest tag name
36
36
  # <offset> - number of commits ahead of <tag>
@@ -40,8 +40,6 @@ module Ronn
40
40
  end
41
41
 
42
42
  # value generated by: rake rev
43
- # or edit manually; I'm not sure of how rake rev interacts with git
44
- # tags -apjanke
45
- REV = '0.10.0-SNAPSHOT'.freeze
43
+ REV = '0.10.1.pre2'.freeze
46
44
  VERSION = version
47
45
  end
data/man/index.html CHANGED
@@ -1,7 +1,7 @@
1
1
  <!DOCTYPE html>
2
2
  <html>
3
3
  <head>
4
- <title>Ronn</title>
4
+ <title>Ronn-NG</title>
5
5
  <style>
6
6
  body {
7
7
  font-size:24px;
@@ -41,16 +41,16 @@
41
41
  </head>
42
42
  <body>
43
43
  <div id='index'>
44
- <h1>Ronn</h1>
44
+ <h1>Ronn-NG</h1>
45
45
  <h3>Builds manuals</h3>
46
46
 
47
47
  <h4>Auxiliary</h4>
48
48
  <p class='aux'>
49
- <a href='http://github.com/apjanke/ronn-ng#readme'>README</a>,
50
- <a href='http://github.com/apjanke/ronn-ng/blob/master/INSTALLING#files'>INSTALLING</a>,
51
- <a href='http://github.com/apjanke/ronn-ng/blob/master/CHANGES#files'>CHANGES</a>,
52
- <a href='http://github.com/apjanke/ronn-ng/blob/master/COPYING#files'>COPYING</a>,
53
- <a href='http://github.com/apjanke/ronn-ng/blob/master/AUTHORS#files'>AUTHORS</a>
49
+ <a href='https://github.com/apjanke/ronn-ng#readme'>README</a>,
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>,
52
+ <a href='https://github.com/apjanke/ronn-ng/blob/main/LICENSE.txt'>LICENSE</a>,
53
+ <a href='https://github.com/apjanke/ronn-ng/blob/main/AUTHORS'>AUTHORS</a>
54
54
  </p>
55
55
 
56
56
  <h4>Manuals</h4>
@@ -64,15 +64,15 @@
64
64
 
65
65
  <h4>See Also</h4>
66
66
  <p class='also'>
67
- <a class='man-ref' href="http://developer.apple.com/mac/library/documentation/Darwin/Reference/ManPages/man5/manpages.5.html">manpages(5)</a>,
68
- <a class='man-ref' href="http://daringfireball.net/projects/markdown/syntax">markdown(7)</a>,
69
- <a class='man-ref' href="http://man.cx/man(1)">man(1)</a>,
70
- <a class='man-ref' href="http://man.cx/roff(7)">roff(7)</a>,
71
- <a class='man-ref' href="http://man.cx/groff(1)">groff(1)</a>,
72
- <a class='man-ref' href="http://mustache.github.com/mustache.5.html">mustache(5)</a>
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>,
70
+ <a class='man-ref' href="https://man7.org/linux/man-pages/man7/roff.7.html">roff(7)</a>,
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>
73
73
  </p>
74
74
 
75
- <p class='copy'>Copyright &copy; 2010 Ryan Tomayko, &copy; 2018 Andrew Janke</p>
75
+ <p class='copy'>Copyright &copy; 2010 Ryan Tomayko, &copy; 2018, 2019, 2020, 2022 Andrew Janke, &copy; 2022 Takuya Noguchi</p>
76
76
  </div>
77
77
  </body>
78
78
  </html>
data/man/index.txt CHANGED
@@ -4,12 +4,12 @@ ronn(5) ronn.5.ronn
4
4
  ronn(7) ronn.7.ronn
5
5
 
6
6
  # external manuals
7
- roff(7) http://man.cx/roff(7)
8
- grep(1) http://man.cx/grep(1)
9
- groff(1) http://man.cx/groff(1)
10
- sh(1) http://man.cx/sh(1posix)
11
- test(1) http://man.cx/test(1)
12
- fork(2) http://man.cx/fork(2)
13
- man(1) http://man.cx/man(1)
14
- markdown(7) http://daringfireball.net/projects/markdown/syntax
15
- manpages(5) http://developer.apple.com/mac/library/documentation/Darwin/Reference/ManPages/man5/manpages.5.html
7
+ roff(7) https://man7.org/linux/man-pages/man7/roff.7.html
8
+ grep(1) https://man7.org/linux/man-pages/man1/grep.1.html
9
+ groff(1) https://man7.org/linux/man-pages/man1/groff.1.html
10
+ sh(1) https://man7.org/linux/man-pages/man1/sh.1p.html
11
+ test(1) https://man7.org/linux/man-pages/man1/test.1.html
12
+ fork(2) https://man7.org/linux/man-pages/man2/fork.2.html
13
+ man(1) https://man7.org/linux/man-pages/man1/man.1.html
14
+ markdown(7) https://daringfireball.net/projects/markdown/syntax
15
+ manpages(5) https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man5/manpages.5.html
data/man/ronn-format.7 CHANGED
@@ -1,6 +1,6 @@
1
- .\" generated with Ronn-NG/v0.9.1
2
- .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "RONN\-FORMAT" "7" "December 2018" "Ronn-NG 0.9.1" "Ronn Manual"
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"
4
4
  .SH "NAME"
5
5
  \fBronn\-format\fR \- manual authoring format based on Markdown
6
6
  .SH "SYNOPSIS"
@@ -83,7 +83,7 @@ HEADING TEXT
83
83
  .P
84
84
  Section headings should be all uppercase and may not contain inline markup\.
85
85
  .SH "INLINE MARKUP"
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:
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
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\.
@@ -97,7 +97,7 @@ User\-specified arguments, variables, or user input\. Typically displayed with \
97
97
  \fB_\fR\fIunderbars\fR\fB_\fR (markdown compatible)
98
98
  Emphasis\. May be used for literal option values\. Typically displayed with \fIunderline\fR in roff output\. HTML output: \fB<em>\fR\.
99
99
  .P
100
- Here is grep(1)\'s DESCRIPTION section represented in \fBronn\fR:
100
+ Here is grep(1)'s DESCRIPTION section represented in \fBronn\fR:
101
101
  .IP "" 4
102
102
  .nf
103
103
  `Grep` searches the named input <FILE> (or standard input if
@@ -107,9 +107,9 @@ prints the matching lines\.
107
107
  .fi
108
108
  .IP "" 0
109
109
  .SH "DEFINITION LISTS"
110
- The definition list syntax is compatible with markdown\'s unordered list syntax but requires that the first line of each list item be terminated with a colon "\fB:\fR" character\. The contents of the first line is the \fIterm\fR; subsequent lines may be comprised of multiple paragraphs, code blocks, standard lists, and nested definition lists\.
110
+ The definition list syntax is compatible with markdown's unordered list syntax but requires that the first line of each list item be terminated with a colon "\fB:\fR" character\. The contents of the first line is the \fIterm\fR; subsequent lines may be comprised of multiple paragraphs, code blocks, standard lists, and nested definition lists\.
111
111
  .P
112
- An example definition list, taken from BSD test(1)\'s \fIDESCRIPTION\fR section:
112
+ An example definition list, taken from BSD test(1)'s \fIDESCRIPTION\fR section:
113
113
  .IP "" 4
114
114
  .nf
115
115
  The following primaries are used to construct expressions: