asciidoctor 2.0.10 → 2.0.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.adoc +294 -30
- data/LICENSE +1 -1
- data/README-de.adoc +16 -20
- data/README-fr.adoc +15 -22
- data/README-jp.adoc +15 -26
- data/README-zh_CN.adoc +21 -25
- data/README.adoc +161 -138
- data/asciidoctor.gemspec +6 -13
- data/data/locale/attributes-ar.adoc +4 -3
- data/data/locale/attributes-be.adoc +23 -0
- data/data/locale/attributes-bg.adoc +4 -3
- data/data/locale/attributes-ca.adoc +6 -5
- data/data/locale/attributes-cs.adoc +4 -3
- data/data/locale/attributes-da.adoc +6 -5
- data/data/locale/attributes-de.adoc +4 -4
- data/data/locale/attributes-en.adoc +4 -4
- data/data/locale/attributes-es.adoc +6 -5
- data/data/locale/attributes-fa.adoc +4 -3
- data/data/locale/attributes-fi.adoc +4 -3
- data/data/locale/attributes-fr.adoc +8 -7
- data/data/locale/attributes-hu.adoc +4 -3
- data/data/locale/attributes-id.adoc +4 -3
- data/data/locale/attributes-it.adoc +6 -5
- data/data/locale/attributes-ja.adoc +4 -3
- data/data/locale/{attributes-kr.adoc → attributes-ko.adoc} +4 -3
- data/data/locale/attributes-nb.adoc +4 -3
- data/data/locale/attributes-nl.adoc +6 -5
- data/data/locale/attributes-nn.adoc +4 -3
- data/data/locale/attributes-pl.adoc +8 -7
- data/data/locale/attributes-pt.adoc +6 -5
- data/data/locale/attributes-pt_BR.adoc +6 -5
- data/data/locale/attributes-ro.adoc +4 -3
- data/data/locale/attributes-ru.adoc +6 -5
- data/data/locale/attributes-sr.adoc +4 -4
- data/data/locale/attributes-sr_Latn.adoc +4 -4
- data/data/locale/attributes-sv.adoc +4 -4
- data/data/locale/attributes-th.adoc +23 -0
- data/data/locale/attributes-tr.adoc +4 -3
- data/data/locale/attributes-uk.adoc +6 -5
- data/data/locale/attributes-vi.adoc +23 -0
- data/data/locale/attributes-zh_CN.adoc +4 -3
- data/data/locale/attributes-zh_TW.adoc +4 -3
- data/data/reference/syntax.adoc +14 -7
- data/data/stylesheets/asciidoctor-default.css +76 -76
- data/data/stylesheets/coderay-asciidoctor.css +9 -9
- data/lib/asciidoctor/abstract_block.rb +20 -13
- data/lib/asciidoctor/abstract_node.rb +23 -12
- data/lib/asciidoctor/attribute_list.rb +64 -72
- data/lib/asciidoctor/block.rb +6 -6
- data/lib/asciidoctor/cli/invoker.rb +3 -2
- data/lib/asciidoctor/cli/options.rb +32 -31
- data/lib/asciidoctor/convert.rb +168 -162
- data/lib/asciidoctor/converter/docbook5.rb +49 -34
- data/lib/asciidoctor/converter/html5.rb +180 -139
- data/lib/asciidoctor/converter/manpage.rb +118 -90
- data/lib/asciidoctor/converter/template.rb +15 -13
- data/lib/asciidoctor/converter.rb +19 -16
- data/lib/asciidoctor/core_ext/hash/merge.rb +1 -1
- data/lib/asciidoctor/document.rb +77 -86
- data/lib/asciidoctor/extensions.rb +22 -16
- data/lib/asciidoctor/helpers.rb +20 -15
- data/lib/asciidoctor/list.rb +2 -6
- data/lib/asciidoctor/load.rb +103 -101
- data/lib/asciidoctor/logging.rb +10 -8
- data/lib/asciidoctor/parser.rb +211 -220
- data/lib/asciidoctor/path_resolver.rb +17 -15
- data/lib/asciidoctor/reader.rb +87 -79
- data/lib/asciidoctor/rx.rb +9 -7
- data/lib/asciidoctor/section.rb +7 -0
- data/lib/asciidoctor/substitutors.rb +167 -148
- data/lib/asciidoctor/syntax_highlighter/coderay.rb +3 -2
- data/lib/asciidoctor/syntax_highlighter/highlightjs.rb +13 -5
- data/lib/asciidoctor/syntax_highlighter/prettify.rb +7 -4
- data/lib/asciidoctor/syntax_highlighter/pygments.rb +19 -11
- data/lib/asciidoctor/syntax_highlighter/rouge.rb +35 -20
- data/lib/asciidoctor/syntax_highlighter.rb +16 -16
- data/lib/asciidoctor/table.rb +70 -43
- data/lib/asciidoctor/timings.rb +3 -3
- data/lib/asciidoctor/version.rb +1 -1
- data/lib/asciidoctor.rb +45 -19
- data/man/asciidoctor.1 +29 -31
- data/man/asciidoctor.adoc +35 -29
- metadata +17 -70
data/lib/asciidoctor.rb
CHANGED
@@ -53,12 +53,12 @@ module Asciidoctor
|
|
53
53
|
module SafeMode
|
54
54
|
# A safe mode level that disables any of the security features enforced
|
55
55
|
# by Asciidoctor (Ruby is still subject to its own restrictions).
|
56
|
-
UNSAFE = 0
|
56
|
+
UNSAFE = 0
|
57
57
|
|
58
58
|
# A safe mode level that closely parallels safe mode in AsciiDoc. This value
|
59
59
|
# prevents access to files which reside outside of the parent directory of
|
60
60
|
# the source file and disables any macro other than the include::[] directive.
|
61
|
-
SAFE = 1
|
61
|
+
SAFE = 1
|
62
62
|
|
63
63
|
# A safe mode level that disallows the document from setting attributes
|
64
64
|
# that would affect the conversion of the document, in addition to all the
|
@@ -66,19 +66,19 @@ module Asciidoctor
|
|
66
66
|
# changing the backend or source-highlighter using an attribute defined
|
67
67
|
# in the source document header. This is the most fundamental level of
|
68
68
|
# security for server deployments (hence the name).
|
69
|
-
SERVER = 10
|
69
|
+
SERVER = 10
|
70
70
|
|
71
71
|
# A safe mode level that disallows the document from attempting to read
|
72
72
|
# files from the file system and including the contents of them into the
|
73
73
|
# document, in additional to all the security features of SafeMode::SERVER.
|
74
74
|
# For instance, this level disallows use of the include::[] directive and the
|
75
75
|
# embedding of binary content (data uri), stylesheets and JavaScripts
|
76
|
-
# referenced by the document.(Asciidoctor and trusted extensions may still
|
76
|
+
# referenced by the document. (Asciidoctor and trusted extensions may still
|
77
77
|
# be allowed to embed trusted content into the document).
|
78
78
|
#
|
79
79
|
# Since Asciidoctor is aiming for wide adoption, this level is the default
|
80
80
|
# and is recommended for server deployments.
|
81
|
-
SECURE = 20
|
81
|
+
SECURE = 20
|
82
82
|
|
83
83
|
# A planned safe mode level that disallows the use of passthrough macros and
|
84
84
|
# prevents the document from setting any known attributes, in addition to all
|
@@ -86,9 +86,9 @@ module Asciidoctor
|
|
86
86
|
#
|
87
87
|
# Please note that this level is not currently implemented (and therefore not
|
88
88
|
# enforced)!
|
89
|
-
#PARANOID = 100
|
89
|
+
#PARANOID = 100
|
90
90
|
|
91
|
-
@names_by_value =
|
91
|
+
@names_by_value = (constants false).map {|sym| [(const_get sym), sym.to_s.downcase] }.sort {|(a), (b)| a <=> b }.to_h
|
92
92
|
|
93
93
|
def self.value_for_name name
|
94
94
|
const_get name.upcase, false
|
@@ -136,8 +136,8 @@ module Asciidoctor
|
|
136
136
|
# Compliance value: true
|
137
137
|
define :underline_style_section_titles, true
|
138
138
|
|
139
|
-
# Asciidoctor will unwrap the content in a preamble
|
140
|
-
#
|
139
|
+
# Asciidoctor will unwrap the content in a preamble if the document has a
|
140
|
+
# title and no sections, then discard the empty preamble.
|
141
141
|
# Compliance value: false
|
142
142
|
define :unwrap_standalone_preamble, true
|
143
143
|
|
@@ -148,7 +148,7 @@ module Asciidoctor
|
|
148
148
|
# Compliance value: 'drop-line'
|
149
149
|
define :attribute_missing, 'skip'
|
150
150
|
|
151
|
-
# AsciiDoc drops lines that contain an attribute
|
151
|
+
# AsciiDoc drops lines that contain an attribute unassignment.
|
152
152
|
# This behavior may need to be tuned depending on the circumstances.
|
153
153
|
# Compliance value: 'drop-line'
|
154
154
|
define :attribute_undefined, 'drop-line'
|
@@ -296,7 +296,7 @@ module Asciidoctor
|
|
296
296
|
DELIMITED_BLOCK_TAILS = {}.tap {|accum| DELIMITED_BLOCKS.each_key {|k| accum[k] = k[k.length - 1] if k.length == 4 } }
|
297
297
|
|
298
298
|
# NOTE the 'figure' key as a string is historical and used by image blocks
|
299
|
-
|
299
|
+
CAPTION_ATTRIBUTE_NAMES = { example: 'example-caption', 'figure' => 'figure-caption', listing: 'listing-caption', table: 'table-caption' }
|
300
300
|
|
301
301
|
LAYOUT_BREAK_CHARS = {
|
302
302
|
'\'' => :thematic_break,
|
@@ -332,7 +332,7 @@ module Asciidoctor
|
|
332
332
|
|
333
333
|
LIST_CONTINUATION = '+'
|
334
334
|
|
335
|
-
# NOTE AsciiDoc
|
335
|
+
# NOTE AsciiDoc.py allows + to be preceded by TAB; Asciidoctor does not
|
336
336
|
HARD_LINE_BREAK = ' +'
|
337
337
|
|
338
338
|
LINE_CONTINUATION = ' \\'
|
@@ -357,9 +357,35 @@ module Asciidoctor
|
|
357
357
|
|
358
358
|
FONT_AWESOME_VERSION = '4.7.0'
|
359
359
|
|
360
|
-
HIGHLIGHT_JS_VERSION = '9.
|
361
|
-
|
362
|
-
MATHJAX_VERSION = '2.7.
|
360
|
+
HIGHLIGHT_JS_VERSION = '9.18.3'
|
361
|
+
|
362
|
+
MATHJAX_VERSION = '2.7.9'
|
363
|
+
|
364
|
+
DEFAULT_ATTRIBUTES = {
|
365
|
+
'appendix-caption' => 'Appendix',
|
366
|
+
'appendix-refsig' => 'Appendix',
|
367
|
+
'caution-caption' => 'Caution',
|
368
|
+
'chapter-refsig' => 'Chapter',
|
369
|
+
#'encoding' => 'UTF-8',
|
370
|
+
'example-caption' => 'Example',
|
371
|
+
'figure-caption' => 'Figure',
|
372
|
+
'important-caption' => 'Important',
|
373
|
+
'last-update-label' => 'Last updated',
|
374
|
+
#'listing-caption' => 'Listing',
|
375
|
+
'note-caption' => 'Note',
|
376
|
+
'part-refsig' => 'Part',
|
377
|
+
#'preface-title' => 'Preface',
|
378
|
+
'prewrap' => '',
|
379
|
+
'sectids' => '',
|
380
|
+
'section-refsig' => 'Section',
|
381
|
+
'table-caption' => 'Table',
|
382
|
+
'tip-caption' => 'Tip',
|
383
|
+
'toc-placement' => 'auto',
|
384
|
+
'toc-title' => 'Table of Contents',
|
385
|
+
'untitled-label' => 'Untitled',
|
386
|
+
'version-label' => 'Version',
|
387
|
+
'warning-caption' => 'Warning',
|
388
|
+
}
|
363
389
|
|
364
390
|
# attributes which be changed throughout the flow of the document (e.g., sectnums)
|
365
391
|
FLEXIBLE_ATTRIBUTES = ['sectnums']
|
@@ -433,9 +459,9 @@ module Asciidoctor
|
|
433
459
|
[:emphasis, :unconstrained, /\\?(?:\[([^\]]+)\])?__(#{CC_ALL}+?)__/m],
|
434
460
|
# _emphasis_
|
435
461
|
[:emphasis, :constrained, /(^|[^#{CC_WORD};:}])(?:\[([^\]]+)\])?_(\S|\S#{CC_ALL}*?\S)_(?!#{CG_WORD})/m],
|
436
|
-
# ##mark## (referred to in AsciiDoc
|
462
|
+
# ##mark## (referred to in AsciiDoc.py as unquoted)
|
437
463
|
[:mark, :unconstrained, /\\?(?:\[([^\]]+)\])?##(#{CC_ALL}+?)##/m],
|
438
|
-
# #mark# (referred to in AsciiDoc
|
464
|
+
# #mark# (referred to in AsciiDoc.py as unquoted)
|
439
465
|
[:mark, :constrained, /(^|[^#{CC_WORD}&;:}])(?:\[([^\]]+)\])?#(\S|\S#{CC_ALL}*?\S)#(?!#{CG_WORD})/m],
|
440
466
|
# ^superscript^
|
441
467
|
[:superscript, :unconstrained, /\\?(?:\[([^\]]+)\])?\^(\S+?)\^/],
|
@@ -511,8 +537,8 @@ module Asciidoctor
|
|
511
537
|
end unless RUBY_ENGINE == 'opal'
|
512
538
|
|
513
539
|
unless RUBY_ENGINE == 'opal'
|
514
|
-
autoload :SyntaxHighlighter, %(#{
|
515
|
-
autoload :Timings, %(#{
|
540
|
+
autoload :SyntaxHighlighter, %(#{__dir__}/asciidoctor/syntax_highlighter)
|
541
|
+
autoload :Timings, %(#{__dir__}/asciidoctor/timings)
|
516
542
|
end
|
517
543
|
end
|
518
544
|
|
data/man/asciidoctor.1
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
'\" t
|
2
2
|
.\" Title: asciidoctor
|
3
|
-
.\" Author: Dan Allen, Sarah White
|
4
|
-
.\" Generator: Asciidoctor 2.0.
|
5
|
-
.\" Date:
|
3
|
+
.\" Author: Dan Allen, Sarah White
|
4
|
+
.\" Generator: Asciidoctor 2.0.17
|
5
|
+
.\" Date: 2022-01-05
|
6
6
|
.\" Manual: Asciidoctor Manual
|
7
|
-
.\" Source: Asciidoctor 2.0.
|
7
|
+
.\" Source: Asciidoctor 2.0.17
|
8
8
|
.\" Language: English
|
9
9
|
.\"
|
10
|
-
.TH "ASCIIDOCTOR" "1" "
|
10
|
+
.TH "ASCIIDOCTOR" "1" "2022-01-05" "Asciidoctor 2.0.17" "Asciidoctor Manual"
|
11
11
|
.ie \n(.g .ds Aq \(aq
|
12
12
|
.el .ds Aq '
|
13
13
|
.ss \n[.ss] 0
|
@@ -77,7 +77,7 @@ This option may be specified more than once.
|
|
77
77
|
.sp
|
78
78
|
\fB\-b, \-\-backend\fP=\fIBACKEND\fP
|
79
79
|
.RS 4
|
80
|
-
Backend output file format: \fIhtml5\fP, \fIdocbook5\fP,
|
80
|
+
Backend output file format: \fIhtml5\fP, \fIdocbook5\fP, and \fImanpage\fP are supported out of the box.
|
81
81
|
You can also use the backend alias names \fIhtml\fP (aliased to \fIhtml5\fP) or \fIdocbook\fP (aliased to \fIdocbook5\fP).
|
82
82
|
Other values can be passed, but if Asciidoctor cannot resolve the backend to a converter, it will fail.
|
83
83
|
Defaults to \fIhtml5\fP.
|
@@ -109,11 +109,10 @@ This name is also used to build the full path to the custom converter templates.
|
|
109
109
|
If a template engine is not specified, it will be auto\-detected based on the file extension of the custom converter templates found.
|
110
110
|
.RE
|
111
111
|
.sp
|
112
|
-
\fB\-e, \-\-
|
112
|
+
\fB\-e, \-\-embedded\fP
|
113
113
|
.RS 4
|
114
|
-
|
115
|
-
|
116
|
-
Defaults to \fIerb\fP.
|
114
|
+
Output an embeddable document, which excludes the header, the footer, and everything outside the body of the document.
|
115
|
+
This option is useful for producing documents that can be inserted into an external template.
|
117
116
|
.RE
|
118
117
|
.sp
|
119
118
|
\fB\-I, \-\-load\-path\fP=\fIDIRECTORY\fP
|
@@ -172,8 +171,8 @@ Matching templates found in subsequent directories override ones previously disc
|
|
172
171
|
.sp
|
173
172
|
\fB\-\-failure\-level\fP=\fILEVEL\fP
|
174
173
|
.RS 4
|
175
|
-
|
176
|
-
If this option is not set
|
174
|
+
Set the minimum logging level (default: FATAL) that yields a non\-zero exit code (i.e., failure).
|
175
|
+
If this option is not set, the program exits with a zero exit code even if warnings or errors have been logged.
|
177
176
|
.RE
|
178
177
|
.sp
|
179
178
|
\fB\-q, \-\-quiet\fP
|
@@ -188,7 +187,7 @@ Include backtrace information when reporting errors.
|
|
188
187
|
.sp
|
189
188
|
\fB\-v, \-\-verbose\fP
|
190
189
|
.RS 4
|
191
|
-
|
190
|
+
Sets log level to DEBUG so application messages logged at INFO or DEBUG level are printed to stderr.
|
192
191
|
.RE
|
193
192
|
.sp
|
194
193
|
\fB\-w, \-\-warnings\fP
|
@@ -207,6 +206,7 @@ Print timings report to stderr (time to read, parse, and convert).
|
|
207
206
|
Print a help message.
|
208
207
|
Show the command usage if \fITOPIC\fP is not specified or recognized.
|
209
208
|
Dump the Asciidoctor man page (in troff/groff format) if \fITOPIC\fP is \fImanpage\fP.
|
209
|
+
Print an AsciiDoc syntax crib sheet (in AsciiDoc) if \fITOPIC\fP is \fIsyntax\fP.
|
210
210
|
.RE
|
211
211
|
.sp
|
212
212
|
\fB\-V, \-\-version\fP
|
@@ -220,7 +220,7 @@ Print program version number.
|
|
220
220
|
\fBAsciidoctor\fP honors the \fBSOURCE_DATE_EPOCH\fP environment variable.
|
221
221
|
If this variable is assigned an integer value, that value is used as the epoch of all input documents and as the local date and time.
|
222
222
|
See \c
|
223
|
-
.URL "https://reproducible\-builds.org/specs/source\-date\-epoch/" "" "
|
223
|
+
.URL "https://reproducible\-builds.org/specs/source\-date\-epoch/" "" ""
|
224
224
|
for more information about this environment variable.
|
225
225
|
.SH "EXIT STATUS"
|
226
226
|
.sp
|
@@ -239,30 +239,28 @@ Refer to the \fBAsciidoctor\fP issue tracker at \c
|
|
239
239
|
.URL "https://github.com/asciidoctor/asciidoctor/issues?q=is%3Aopen" "" "."
|
240
240
|
.SH "AUTHORS"
|
241
241
|
.sp
|
242
|
-
\fBAsciidoctor\fP
|
242
|
+
\fBAsciidoctor\fP is led and maintained by Dan Allen and Sarah White and has received contributions from many individuals in the Asciidoctor community.
|
243
|
+
The project was started in 2012 by Ryan Waldron based on a prototype written by Nick Hengeveld for the Git website.
|
244
|
+
Jason Porter wrote the first implementation of the CLI interface provided by this command.
|
243
245
|
.sp
|
244
|
-
\fBAsciiDoc\fP was
|
246
|
+
\fBAsciiDoc.py\fP was created by Stuart Rackham and has received contributions from many individuals in the AsciiDoc.py community.
|
245
247
|
.SH "RESOURCES"
|
246
248
|
.sp
|
247
|
-
\fBProject
|
249
|
+
\fBProject website:\fP \c
|
248
250
|
.URL "https://asciidoctor.org" "" ""
|
249
251
|
.sp
|
250
|
-
\
|
252
|
+
\fBProject documentation:\fP \c
|
253
|
+
.URL "https://docs.asciidoctor.org" "" ""
|
254
|
+
.sp
|
255
|
+
\fBSource repository:\fP \c
|
251
256
|
.URL "https://github.com/asciidoctor/asciidoctor" "" ""
|
252
257
|
.sp
|
253
|
-
\
|
254
|
-
.URL "https://
|
258
|
+
\fBCommunity chat:\fP \c
|
259
|
+
.URL "https://asciidoctor.zulipchat.com" "" ""
|
255
260
|
.sp
|
256
|
-
\fBDiscussion list
|
257
|
-
.URL "
|
261
|
+
\fBDiscussion list:\fP \c
|
262
|
+
.URL "https://discuss.asciidoctor.org" "" ""
|
258
263
|
.SH "COPYING"
|
259
264
|
.sp
|
260
|
-
Copyright (C) 2012\-
|
261
|
-
|
262
|
-
.SH "AUTHORS"
|
263
|
-
.sp
|
264
|
-
Dan Allen
|
265
|
-
.sp
|
266
|
-
Sarah White
|
267
|
-
.sp
|
268
|
-
Ryan Waldron
|
265
|
+
Copyright (C) 2012\-present Dan Allen, Sarah White, Ryan Waldron, and the individual contributors to Asciidoctor.
|
266
|
+
Use of this software is granted under the terms of the MIT License.
|
data/man/asciidoctor.adoc
CHANGED
@@ -1,27 +1,28 @@
|
|
1
1
|
= asciidoctor(1)
|
2
|
-
Dan Allen; Sarah White
|
2
|
+
Dan Allen; Sarah White
|
3
3
|
:doctype: manpage
|
4
|
-
:release-version: 2.0.
|
4
|
+
:release-version: 2.0.17
|
5
5
|
:man manual: Asciidoctor Manual
|
6
6
|
:man source: Asciidoctor {release-version}
|
7
|
-
|
7
|
+
ifdef::backend-manpage[:!author:]
|
8
8
|
|
9
|
-
==
|
9
|
+
== Name
|
10
10
|
|
11
11
|
asciidoctor - converts AsciiDoc source files to HTML, DocBook, and other formats
|
12
12
|
|
13
|
-
==
|
13
|
+
== Synopsis
|
14
14
|
|
15
15
|
*asciidoctor* [_OPTION_]... _FILE_...
|
16
16
|
|
17
|
-
==
|
17
|
+
== Description
|
18
18
|
|
19
19
|
The asciidoctor(1) command converts the AsciiDoc source file(s) _FILE_ to HTML5, DocBook 5, man(ual) page, and other custom output formats.
|
20
20
|
|
21
21
|
If _FILE_ is _-_ then the AsciiDoc source is read from standard input.
|
22
22
|
|
23
|
-
==
|
23
|
+
== Options
|
24
24
|
|
25
|
+
// tag::options[]
|
25
26
|
=== Security Settings
|
26
27
|
|
27
28
|
*-B, --base-dir*=_DIR_::
|
@@ -53,7 +54,7 @@ Values containing spaces should be enclosed in quotes.
|
|
53
54
|
This option may be specified more than once.
|
54
55
|
|
55
56
|
*-b, --backend*=_BACKEND_::
|
56
|
-
Backend output file format: _html5_, _docbook5_,
|
57
|
+
Backend output file format: _html5_, _docbook5_, and _manpage_ are supported out of the box.
|
57
58
|
You can also use the backend alias names _html_ (aliased to _html5_) or _docbook_ (aliased to _docbook5_).
|
58
59
|
Other values can be passed, but if Asciidoctor cannot resolve the backend to a converter, it will fail.
|
59
60
|
Defaults to _html5_.
|
@@ -79,10 +80,9 @@ This option may be specified more than once.
|
|
79
80
|
This name is also used to build the full path to the custom converter templates.
|
80
81
|
If a template engine is not specified, it will be auto-detected based on the file extension of the custom converter templates found.
|
81
82
|
|
82
|
-
*-e, --
|
83
|
-
|
84
|
-
|
85
|
-
Defaults to _erb_.
|
83
|
+
*-e, --embedded*::
|
84
|
+
Output an embeddable document, which excludes the header, the footer, and everything outside the body of the document.
|
85
|
+
This option is useful for producing documents that can be inserted into an external template.
|
86
86
|
|
87
87
|
*-I, --load-path*=_DIRECTORY_::
|
88
88
|
Add the specified directory to the load path, so that _-r_ can load extensions from outside the default Ruby load path.
|
@@ -126,8 +126,8 @@ Matching templates found in subsequent directories override ones previously disc
|
|
126
126
|
=== Processing Information
|
127
127
|
|
128
128
|
*--failure-level*=_LEVEL_::
|
129
|
-
|
130
|
-
If this option is not set
|
129
|
+
Set the minimum logging level (default: FATAL) that yields a non-zero exit code (i.e., failure).
|
130
|
+
If this option is not set, the program exits with a zero exit code even if warnings or errors have been logged.
|
131
131
|
|
132
132
|
*-q, --quiet*::
|
133
133
|
Silence application log messages and script warnings.
|
@@ -136,7 +136,7 @@ Matching templates found in subsequent directories override ones previously disc
|
|
136
136
|
Include backtrace information when reporting errors.
|
137
137
|
|
138
138
|
*-v, --verbose*::
|
139
|
-
|
139
|
+
Sets log level to DEBUG so application messages logged at INFO or DEBUG level are printed to stderr.
|
140
140
|
|
141
141
|
*-w, --warnings*::
|
142
142
|
Turn on script warnings (applies to executed code).
|
@@ -150,19 +150,21 @@ Matching templates found in subsequent directories override ones previously disc
|
|
150
150
|
Print a help message.
|
151
151
|
Show the command usage if _TOPIC_ is not specified or recognized.
|
152
152
|
Dump the Asciidoctor man page (in troff/groff format) if _TOPIC_ is _manpage_.
|
153
|
+
Print an AsciiDoc syntax crib sheet (in AsciiDoc) if _TOPIC_ is _syntax_.
|
153
154
|
|
154
155
|
*-V, --version*::
|
155
156
|
Print program version number.
|
156
157
|
+
|
157
158
|
*-v* can also be used if no source files are specified.
|
159
|
+
// end::options[]
|
158
160
|
|
159
|
-
==
|
161
|
+
== Environment
|
160
162
|
|
161
163
|
*Asciidoctor* honors the *SOURCE_DATE_EPOCH* environment variable.
|
162
164
|
If this variable is assigned an integer value, that value is used as the epoch of all input documents and as the local date and time.
|
163
165
|
See https://reproducible-builds.org/specs/source-date-epoch/ for more information about this environment variable.
|
164
166
|
|
165
|
-
==
|
167
|
+
== Exit Status
|
166
168
|
|
167
169
|
*0*::
|
168
170
|
Success.
|
@@ -170,27 +172,31 @@ See https://reproducible-builds.org/specs/source-date-epoch/ for more informatio
|
|
170
172
|
*1*::
|
171
173
|
Failure (syntax or usage error; configuration error; document processing failure; unexpected error).
|
172
174
|
|
173
|
-
==
|
175
|
+
== Bugs
|
174
176
|
|
175
177
|
Refer to the *Asciidoctor* issue tracker at https://github.com/asciidoctor/asciidoctor/issues?q=is%3Aopen.
|
176
178
|
|
177
|
-
==
|
179
|
+
== Authors
|
180
|
+
|
181
|
+
*Asciidoctor* is led and maintained by Dan Allen and Sarah White and has received contributions from many individuals in the Asciidoctor community.
|
182
|
+
The project was started in 2012 by Ryan Waldron based on a prototype written by Nick Hengeveld for the Git website.
|
183
|
+
Jason Porter wrote the first implementation of the CLI interface provided by this command.
|
178
184
|
|
179
|
-
*
|
185
|
+
*AsciiDoc.py* was created by Stuart Rackham and has received contributions from many individuals in the AsciiDoc.py community.
|
180
186
|
|
181
|
-
|
187
|
+
== Resources
|
182
188
|
|
183
|
-
|
189
|
+
*Project website:* https://asciidoctor.org
|
184
190
|
|
185
|
-
*Project
|
191
|
+
*Project documentation:* https://docs.asciidoctor.org
|
186
192
|
|
187
|
-
*
|
193
|
+
*Source repository:* https://github.com/asciidoctor/asciidoctor
|
188
194
|
|
189
|
-
*
|
195
|
+
*Community chat:* https://asciidoctor.zulipchat.com
|
190
196
|
|
191
|
-
*Discussion list
|
197
|
+
*Discussion list:* https://discuss.asciidoctor.org
|
192
198
|
|
193
|
-
==
|
199
|
+
== Copying
|
194
200
|
|
195
|
-
Copyright \(C) 2012-
|
196
|
-
|
201
|
+
Copyright \(C) 2012-present Dan Allen, Sarah White, Ryan Waldron, and the individual contributors to Asciidoctor.
|
202
|
+
Use of this software is granted under the terms of the MIT License.
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: asciidoctor
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.0.
|
4
|
+
version: 2.0.17
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Dan Allen
|
@@ -13,36 +13,8 @@ authors:
|
|
13
13
|
autorequire:
|
14
14
|
bindir: bin
|
15
15
|
cert_chain: []
|
16
|
-
date:
|
16
|
+
date: 2022-01-06 00:00:00.000000000 Z
|
17
17
|
dependencies:
|
18
|
-
- !ruby/object:Gem::Dependency
|
19
|
-
name: asciimath
|
20
|
-
requirement: !ruby/object:Gem::Requirement
|
21
|
-
requirements:
|
22
|
-
- - "~>"
|
23
|
-
- !ruby/object:Gem::Version
|
24
|
-
version: 1.0.0
|
25
|
-
type: :development
|
26
|
-
prerelease: false
|
27
|
-
version_requirements: !ruby/object:Gem::Requirement
|
28
|
-
requirements:
|
29
|
-
- - "~>"
|
30
|
-
- !ruby/object:Gem::Version
|
31
|
-
version: 1.0.0
|
32
|
-
- !ruby/object:Gem::Dependency
|
33
|
-
name: coderay
|
34
|
-
requirement: !ruby/object:Gem::Requirement
|
35
|
-
requirements:
|
36
|
-
- - "~>"
|
37
|
-
- !ruby/object:Gem::Version
|
38
|
-
version: 1.1.0
|
39
|
-
type: :development
|
40
|
-
prerelease: false
|
41
|
-
version_requirements: !ruby/object:Gem::Requirement
|
42
|
-
requirements:
|
43
|
-
- - "~>"
|
44
|
-
- !ruby/object:Gem::Version
|
45
|
-
version: 1.1.0
|
46
18
|
- !ruby/object:Gem::Dependency
|
47
19
|
name: concurrent-ruby
|
48
20
|
requirement: !ruby/object:Gem::Requirement
|
@@ -72,47 +44,47 @@ dependencies:
|
|
72
44
|
- !ruby/object:Gem::Version
|
73
45
|
version: 3.1.0
|
74
46
|
- !ruby/object:Gem::Dependency
|
75
|
-
name:
|
47
|
+
name: erubi
|
76
48
|
requirement: !ruby/object:Gem::Requirement
|
77
49
|
requirements:
|
78
50
|
- - "~>"
|
79
51
|
- !ruby/object:Gem::Version
|
80
|
-
version:
|
52
|
+
version: 1.10.0
|
81
53
|
type: :development
|
82
54
|
prerelease: false
|
83
55
|
version_requirements: !ruby/object:Gem::Requirement
|
84
56
|
requirements:
|
85
57
|
- - "~>"
|
86
58
|
- !ruby/object:Gem::Version
|
87
|
-
version:
|
59
|
+
version: 1.10.0
|
88
60
|
- !ruby/object:Gem::Dependency
|
89
61
|
name: haml
|
90
62
|
requirement: !ruby/object:Gem::Requirement
|
91
63
|
requirements:
|
92
64
|
- - "~>"
|
93
65
|
- !ruby/object:Gem::Version
|
94
|
-
version: 5.
|
66
|
+
version: 5.2.0
|
95
67
|
type: :development
|
96
68
|
prerelease: false
|
97
69
|
version_requirements: !ruby/object:Gem::Requirement
|
98
70
|
requirements:
|
99
71
|
- - "~>"
|
100
72
|
- !ruby/object:Gem::Version
|
101
|
-
version: 5.
|
73
|
+
version: 5.2.0
|
102
74
|
- !ruby/object:Gem::Dependency
|
103
75
|
name: minitest
|
104
76
|
requirement: !ruby/object:Gem::Requirement
|
105
77
|
requirements:
|
106
78
|
- - "~>"
|
107
79
|
- !ruby/object:Gem::Version
|
108
|
-
version: 5.
|
80
|
+
version: 5.14.0
|
109
81
|
type: :development
|
110
82
|
prerelease: false
|
111
83
|
version_requirements: !ruby/object:Gem::Requirement
|
112
84
|
requirements:
|
113
85
|
- - "~>"
|
114
86
|
- !ruby/object:Gem::Version
|
115
|
-
version: 5.
|
87
|
+
version: 5.14.0
|
116
88
|
- !ruby/object:Gem::Dependency
|
117
89
|
name: nokogiri
|
118
90
|
requirement: !ruby/object:Gem::Requirement
|
@@ -141,48 +113,20 @@ dependencies:
|
|
141
113
|
- - "~>"
|
142
114
|
- !ruby/object:Gem::Version
|
143
115
|
version: 12.3.0
|
144
|
-
- !ruby/object:Gem::Dependency
|
145
|
-
name: rouge
|
146
|
-
requirement: !ruby/object:Gem::Requirement
|
147
|
-
requirements:
|
148
|
-
- - "~>"
|
149
|
-
- !ruby/object:Gem::Version
|
150
|
-
version: 3.3.0
|
151
|
-
type: :development
|
152
|
-
prerelease: false
|
153
|
-
version_requirements: !ruby/object:Gem::Requirement
|
154
|
-
requirements:
|
155
|
-
- - "~>"
|
156
|
-
- !ruby/object:Gem::Version
|
157
|
-
version: 3.3.0
|
158
|
-
- !ruby/object:Gem::Dependency
|
159
|
-
name: rspec-expectations
|
160
|
-
requirement: !ruby/object:Gem::Requirement
|
161
|
-
requirements:
|
162
|
-
- - "~>"
|
163
|
-
- !ruby/object:Gem::Version
|
164
|
-
version: 3.8.0
|
165
|
-
type: :development
|
166
|
-
prerelease: false
|
167
|
-
version_requirements: !ruby/object:Gem::Requirement
|
168
|
-
requirements:
|
169
|
-
- - "~>"
|
170
|
-
- !ruby/object:Gem::Version
|
171
|
-
version: 3.8.0
|
172
116
|
- !ruby/object:Gem::Dependency
|
173
117
|
name: slim
|
174
118
|
requirement: !ruby/object:Gem::Requirement
|
175
119
|
requirements:
|
176
120
|
- - "~>"
|
177
121
|
- !ruby/object:Gem::Version
|
178
|
-
version: 4.
|
122
|
+
version: 4.1.0
|
179
123
|
type: :development
|
180
124
|
prerelease: false
|
181
125
|
version_requirements: !ruby/object:Gem::Requirement
|
182
126
|
requirements:
|
183
127
|
- - "~>"
|
184
128
|
- !ruby/object:Gem::Version
|
185
|
-
version: 4.
|
129
|
+
version: 4.1.0
|
186
130
|
- !ruby/object:Gem::Dependency
|
187
131
|
name: tilt
|
188
132
|
requirement: !ruby/object:Gem::Requirement
|
@@ -217,6 +161,7 @@ files:
|
|
217
161
|
- asciidoctor.gemspec
|
218
162
|
- bin/asciidoctor
|
219
163
|
- data/locale/attributes-ar.adoc
|
164
|
+
- data/locale/attributes-be.adoc
|
220
165
|
- data/locale/attributes-bg.adoc
|
221
166
|
- data/locale/attributes-ca.adoc
|
222
167
|
- data/locale/attributes-cs.adoc
|
@@ -231,7 +176,7 @@ files:
|
|
231
176
|
- data/locale/attributes-id.adoc
|
232
177
|
- data/locale/attributes-it.adoc
|
233
178
|
- data/locale/attributes-ja.adoc
|
234
|
-
- data/locale/attributes-
|
179
|
+
- data/locale/attributes-ko.adoc
|
235
180
|
- data/locale/attributes-nb.adoc
|
236
181
|
- data/locale/attributes-nl.adoc
|
237
182
|
- data/locale/attributes-nn.adoc
|
@@ -243,8 +188,10 @@ files:
|
|
243
188
|
- data/locale/attributes-sr.adoc
|
244
189
|
- data/locale/attributes-sr_Latn.adoc
|
245
190
|
- data/locale/attributes-sv.adoc
|
191
|
+
- data/locale/attributes-th.adoc
|
246
192
|
- data/locale/attributes-tr.adoc
|
247
193
|
- data/locale/attributes-uk.adoc
|
194
|
+
- data/locale/attributes-vi.adoc
|
248
195
|
- data/locale/attributes-zh_CN.adoc
|
249
196
|
- data/locale/attributes-zh_TW.adoc
|
250
197
|
- data/locale/attributes.adoc
|
@@ -306,7 +253,7 @@ licenses:
|
|
306
253
|
- MIT
|
307
254
|
metadata:
|
308
255
|
bug_tracker_uri: https://github.com/asciidoctor/asciidoctor/issues
|
309
|
-
changelog_uri: https://github.com/asciidoctor/asciidoctor/blob/
|
256
|
+
changelog_uri: https://github.com/asciidoctor/asciidoctor/blob/HEAD/CHANGELOG.adoc
|
310
257
|
mailing_list_uri: http://discuss.asciidoctor.org
|
311
258
|
source_code_uri: https://github.com/asciidoctor/asciidoctor
|
312
259
|
post_install_message:
|
@@ -324,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
324
271
|
- !ruby/object:Gem::Version
|
325
272
|
version: '0'
|
326
273
|
requirements: []
|
327
|
-
rubygems_version: 3.
|
274
|
+
rubygems_version: 3.2.32
|
328
275
|
signing_key:
|
329
276
|
specification_version: 4
|
330
277
|
summary: An implementation of the AsciiDoc text processor and publishing toolchain
|