asciidoctor 1.5.3 → 1.5.4
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of asciidoctor might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/CHANGELOG.adoc +67 -5
- data/CONTRIBUTING.adoc +171 -0
- data/LICENSE.adoc +1 -1
- data/README.adoc +62 -30
- data/bin/asciidoctor +3 -3
- data/bin/asciidoctor-safe +8 -5
- data/lib/asciidoctor.rb +10 -21
- data/lib/asciidoctor/abstract_block.rb +29 -11
- data/lib/asciidoctor/abstract_node.rb +11 -6
- data/lib/asciidoctor/callouts.rb +6 -10
- data/lib/asciidoctor/cli/options.rb +2 -2
- data/lib/asciidoctor/converter.rb +1 -1
- data/lib/asciidoctor/converter/docbook5.rb +46 -23
- data/lib/asciidoctor/converter/factory.rb +3 -3
- data/lib/asciidoctor/converter/html5.rb +27 -24
- data/lib/asciidoctor/converter/manpage.rb +72 -61
- data/lib/asciidoctor/converter/template.rb +5 -9
- data/lib/asciidoctor/document.rb +18 -18
- data/lib/asciidoctor/extensions.rb +5 -5
- data/lib/asciidoctor/helpers.rb +2 -2
- data/lib/asciidoctor/inline.rb +2 -2
- data/lib/asciidoctor/parser.rb +59 -59
- data/lib/asciidoctor/path_resolver.rb +23 -15
- data/lib/asciidoctor/reader.rb +34 -29
- data/lib/asciidoctor/section.rb +6 -8
- data/lib/asciidoctor/substitutors.rb +2 -2
- data/lib/asciidoctor/table.rb +46 -23
- data/lib/asciidoctor/version.rb +1 -1
- data/man/asciidoctor.1 +11 -11
- data/man/asciidoctor.adoc +2 -2
- data/test/attributes_test.rb +21 -37
- data/test/blocks_test.rb +41 -14
- data/test/converter_test.rb +4 -4
- data/test/document_test.rb +61 -8
- data/test/extensions_test.rb +2 -2
- data/test/invoker_test.rb +3 -3
- data/test/links_test.rb +13 -3
- data/test/lists_test.rb +114 -114
- data/test/manpage_test.rb +203 -0
- data/test/paragraphs_test.rb +3 -3
- data/test/parser_test.rb +4 -4
- data/test/preamble_test.rb +1 -1
- data/test/reader_test.rb +149 -109
- data/test/sections_test.rb +137 -27
- data/test/substitutions_test.rb +24 -16
- data/test/tables_test.rb +183 -31
- data/test/test_helper.rb +10 -22
- metadata +9 -6
- data/compat/asciidoc.conf +0 -395
- data/compat/font-awesome-3-compat.css +0 -397
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 535a8de8deadb9acd40a7d412f1e148ef33cd5d6
|
4
|
+
data.tar.gz: 3706223606515ac060f8a2078b3d796719bdef26
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 08ba16f2d379ae31508ee3f1963a45c078e4ce8dd20adf106df02f35ac89e0161a1253adbc4313baf4149cab5e7c9b8fb5f1ee2c53c57e844e3f0457b221b4e1
|
7
|
+
data.tar.gz: a5292f0b48dcbee18188b2f0de51bd3306fbed3aa09b1b0a647f00df00f01c74510878b0161b3c25ca1d1c983cf6645cd7e07e61a03a13dba41536327fb623c0
|
data/CHANGELOG.adoc
CHANGED
@@ -11,6 +11,66 @@ endif::[]
|
|
11
11
|
This document provides a high-level view of the changes introduced in Asciidoctor by release.
|
12
12
|
For a detailed view of what has changed, refer to the https://github.com/asciidoctor/asciidoctor/commits/master[commit history] on GitHub.
|
13
13
|
|
14
|
+
// tag::compact[]
|
15
|
+
== 1.5.4 (2016-01-03) - @mojavelinux
|
16
|
+
|
17
|
+
Enhancements::
|
18
|
+
* translate README into French (@anthonny, @mogztter, @gscheibel, @mgreau) (#1630)
|
19
|
+
* allow linkstyle in manpage output to be configured (#1610)
|
20
|
+
|
21
|
+
Improvements::
|
22
|
+
* upgrade to MathJax 2.6.0 and disable loading messages
|
23
|
+
* upgrade to Font Awesome 4.5.0
|
24
|
+
* disable toc if document has no sections (#1633)
|
25
|
+
* convert inline asciimath to MathML (using asciimath gem) in DocBook converter (#1622)
|
26
|
+
* add attribute to control build reproducibility (@bk2204) (#1453)
|
27
|
+
* recognize \file:/// as a file root in Opal browser env (#1561)
|
28
|
+
* honor icon attribute on admonition block when font-based icons are enabled (@robertpanzer) (#1593)
|
29
|
+
* resolve custom icon relative to iconsdir; add file extension if absent (#1634)
|
30
|
+
* allow asciidoctor cli to resolve library path when invoked without leading ./
|
31
|
+
|
32
|
+
Compliance::
|
33
|
+
* allow special section to be nested at any depth (#1591)
|
34
|
+
* ensure colpcwidth values add up to 100%; increase precision of values to 4 decimal places (#1647)
|
35
|
+
* ignore blank cols attribute on table (#1647)
|
36
|
+
* support shorthand syntax for block attributes on document title (#1650)
|
37
|
+
|
38
|
+
Bug fixes::
|
39
|
+
* don't include default toc in AsciiDoc table cell; don't pass toc location attributes to nested document (#1582)
|
40
|
+
* guard against nil dlist list item in find_by (#1618)
|
41
|
+
* don't swallow trailing line when include file is not readable (#1602)
|
42
|
+
* change xlink namespace to xl in DocBook 5 output to prevent parse error (#1597)
|
43
|
+
* make callouts globally unique within document, including AsciiDoc table cells (#1626)
|
44
|
+
* initialize Slim-related attributes regardless of when Slim was loaded (@terceiro) (#1576)
|
45
|
+
* differentiate literal backslash from escape sequence in manpage output (@ds26gte) (#1604)
|
46
|
+
* don't mistake line beginning with \. for troff macro in manpage output (@ds26gte) (#1589)
|
47
|
+
* escape leading dots so user content doesn't trigger troff macros in manpage output (@ds26gte) (#1631)
|
48
|
+
* use \c after .URL macro to remove extraneous space in manpage output (@ds26gte) (#1590)
|
49
|
+
* fix missing endline after .URL macro in manpage output (#1613)
|
50
|
+
* properly handle spacing around .URL/.MTO macro in manpage output (@ds26gte) (#1641)
|
51
|
+
* don't swallow doctitle attribute followed by block title (#1587)
|
52
|
+
* change strategy for splitting names of author; fixes bug in Opal/Asciidoctor.js
|
53
|
+
* don't fail if library is loaded more than once
|
54
|
+
|
55
|
+
Infrastructure::
|
56
|
+
* remove trailing endlines in project source code
|
57
|
+
* update contributing guidelines
|
58
|
+
* explicitly test ifeval scenario raised in issue #1585
|
59
|
+
* remove backreference substitution hack for Opal/Asciidoctor.js
|
60
|
+
* fix assignment of default Hash value for Opal/Asciidoctor.js
|
61
|
+
* add JRuby 9.0.4.0 and Ruby 2.3.0 to the Travis CI build matrix
|
62
|
+
|
63
|
+
Distribution Packages::
|
64
|
+
|
65
|
+
* http://rubygems.org/gems/asciidoctor[RubyGem (asciidoctor)]
|
66
|
+
* https://apps.fedoraproject.org/packages/rubygem-asciidoctor[Fedora (rubygem-asciidoctor)]
|
67
|
+
* http://packages.debian.org/sid/asciidoctor[Debian (asciidoctor)]
|
68
|
+
* http://packages.ubuntu.com/saucy/asciidoctor[Ubuntu (asciidoctor)]
|
69
|
+
|
70
|
+
https://github.com/asciidoctor/asciidoctor/issues?q=milestone%3Av1.5.4[issues resolved] |
|
71
|
+
https://github.com/asciidoctor/asciidoctor/releases/tag/v1.5.4[git tag] |
|
72
|
+
https://github.com/asciidoctor/asciidoctor/compare/v1.5.3...v1.5.4[full diff]
|
73
|
+
|
14
74
|
== 1.5.3 (2015-10-31) - @mojavelinux
|
15
75
|
|
16
76
|
Enhancements::
|
@@ -21,11 +81,12 @@ Enhancements::
|
|
21
81
|
* allow text of selected lines to be highlighted in source block by Pygments or CodeRay (#1429)
|
22
82
|
* use value of `docinfo` attribute to control docinfo behavior (#1510)
|
23
83
|
* add `docinfosubs` attribute to control which substitutions are performed on docinfo files (@mogztter) (#405)
|
24
|
-
*
|
84
|
+
* drop ability to specify multiple attributes with a single `-a` flag when using the CLI (@mogztter) (#405)
|
85
|
+
* make subtitle separator chars for document title configurable (@rmannibucau) (#1350)
|
25
86
|
* make XrefInlineRx regexp more permissive (Mathieu Boespflug) (#844)
|
26
87
|
|
27
88
|
Improvements::
|
28
|
-
* load JavaScript and CSS at
|
89
|
+
* load JavaScript and CSS at bottom of HTML document (@mogztter) (#1238)
|
29
90
|
* list available backends in help text (@plaindocs) (#1271)
|
30
91
|
* properly expand tabs in literal text (#1170, #841)
|
31
92
|
* add `source-indent` as document attribute (@mogztter) (#1169)
|
@@ -63,7 +124,7 @@ Improvements::
|
|
63
124
|
* document `-I` and `-r` options in the manual page (@bk2204)
|
64
125
|
* fix `+--help+` output text for `-I` (@bk2204)
|
65
126
|
* don't require open-uri-cached if already loaded
|
66
|
-
* do not attempt to scan pattern of non-existent directory
|
127
|
+
* do not attempt to scan pattern of non-existent directory in template converter
|
67
128
|
|
68
129
|
Compliance::
|
69
130
|
* use `<sup>` for footnote reference in text instead of `<span>` (#1523)
|
@@ -170,6 +231,7 @@ Distribution Packages::
|
|
170
231
|
https://github.com/asciidoctor/asciidoctor/issues?q=milestone%3Av1.5.2[issues resolved] |
|
171
232
|
https://github.com/asciidoctor/asciidoctor/releases/tag/v1.5.2[git tag] |
|
172
233
|
https://github.com/asciidoctor/asciidoctor/compare/v1.5.1...v1.5.2[full diff]
|
234
|
+
// end::compact[]
|
173
235
|
|
174
236
|
== 1.5.1 (2014-09-29) - @mojavelinux
|
175
237
|
|
@@ -254,7 +316,7 @@ Improvements::
|
|
254
316
|
* {star} use glyphs for checkboxes when not using font icons (#878)
|
255
317
|
* {star} prefer source-language attribute over language attribute for defining default source language (#888)
|
256
318
|
* {star} pass document as first argument to process method on Preprocessor
|
257
|
-
* don't parse link attributes when linkattrs is set unless text contains equal sign
|
319
|
+
* don't parse link attributes when linkattrs is set unless text contains equal sign
|
258
320
|
* detect bare links, mark with bare class; don't repeat URL of bare link in print styles
|
259
321
|
* allow Treeprocessor#process method to replace tree (#1035)
|
260
322
|
* add AbstractNode#find_by method to locate nodes in tree (#862)
|
@@ -479,7 +541,7 @@ Improvements::
|
|
479
541
|
* improved the built-in CodeRay theme to match Asciidoctor styles
|
480
542
|
* link to CodeRay stylesheet if linkcss is set (#381)
|
481
543
|
* style the video block (title & margin) (#590)
|
482
|
-
* added Groovy, Clojure, Python and YAML to floating language hint
|
544
|
+
* added Groovy, Clojure, Python and YAML to floating language hint
|
483
545
|
* only process callouts for blocks in which callouts are found
|
484
546
|
* added content_model to AbstractBlock, rename buffer to lines
|
485
547
|
* use Untitled as document title in rendered output if document has no title
|
data/CONTRIBUTING.adoc
ADDED
@@ -0,0 +1,171 @@
|
|
1
|
+
= Contributing
|
2
|
+
// settings:
|
3
|
+
:idprefix:
|
4
|
+
:idseparator: -
|
5
|
+
:source-language: ruby
|
6
|
+
:language: {source-language}
|
7
|
+
ifdef::env-github,env-browser[:outfilesuffix: .adoc]
|
8
|
+
// URIs:
|
9
|
+
:uri-repo: https://github.com/asciidoctor/asciidoctor
|
10
|
+
:uri-help-base: https://help.github.com/articles
|
11
|
+
:uri-issues: {uri-repo}/issues
|
12
|
+
:uri-fork-help: {uri-help-base}/fork-a-repo
|
13
|
+
:uri-branch-help: {uri-fork-help}#create-branches
|
14
|
+
:uri-pr-help: {uri-help-base}/using-pull-requests
|
15
|
+
:uri-gist: https://gist.github.com
|
16
|
+
|
17
|
+
== License Agreement
|
18
|
+
|
19
|
+
By contributing changes to this repository, you agree to license your contributions under the <<LICENSE#,MIT license>>.
|
20
|
+
This ensures your contributions have the same license as the project and that the community is free to use your contributions.
|
21
|
+
You also assert that you are the original author of the work that you are contributing unless otherwise stated.
|
22
|
+
|
23
|
+
== Submitting an Issue
|
24
|
+
|
25
|
+
We use the {uri-issues}[issue tracker on GitHub] associated with this project to track bugs and features.
|
26
|
+
Before submitting a bug report or feature request, check to make sure it hasn't already been submitted.
|
27
|
+
When submitting a bug report, please include a {uri-gist}[Gist] that includes any details that may help reproduce the bug, including your gem version, Ruby version, and operating system.
|
28
|
+
|
29
|
+
Most importantly, since Asciidoctor is a text processor, reproducing most bugs requires that we have some snippet of text on which Asciidoctor exhibits the bad behavior.
|
30
|
+
|
31
|
+
An ideal bug report would include a pull request with failing specs.
|
32
|
+
|
33
|
+
== Submitting a Pull Request
|
34
|
+
|
35
|
+
. {uri-fork-help}[Fork the repository].
|
36
|
+
. Run `bundle` to install development dependencies.
|
37
|
+
* If the `bundle` command is not available, run `gem install bundler` to install it.
|
38
|
+
. {uri-branch-help}[Create a topic branch] (preferably using the pattern `issue-XYZ`, where `XYZ` is the issue number).
|
39
|
+
. Add tests for your unimplemented feature or bug fix. (See <<writing-and-executing-tests>>)
|
40
|
+
. Run `bundle exec rake` to run the tests.
|
41
|
+
If your tests pass, return to step 3.
|
42
|
+
. Implement your feature or bug fix.
|
43
|
+
. Run `bundle exec rake` to run the tests.
|
44
|
+
If your tests fail, return to step 5.
|
45
|
+
. Add documentation for your feature or bug fix.
|
46
|
+
. If your changes are not 100% documented, go back to step 7.
|
47
|
+
. Add, commit, and push your changes.
|
48
|
+
. {uri-pr-help}[Submit a pull request].
|
49
|
+
|
50
|
+
For ideas about how to use pull requests, see the post http://blog.quickpeople.co.uk/2013/07/10/useful-github-patterns[Useful GitHub Patterns].
|
51
|
+
|
52
|
+
=== Background Knowledge
|
53
|
+
|
54
|
+
As Asciidoctor is built using Ruby some basic knowledge of Ruby, RubyGems and Minitest is beneficial. The following resources provide a good starting point for contributors who may not be completely comfortable with these tools:
|
55
|
+
|
56
|
+
* https://www.ruby-lang.org/en/documentation/quickstart/[Ruby in 20 minutes]
|
57
|
+
* https://www.ruby-lang.org/en/documentation/ruby-from-other-languages/[Ruby from other languages]
|
58
|
+
* http://guides.rubygems.org/rubygems-basics/[RubyGems basics]
|
59
|
+
* http://guides.rubygems.org/what-is-a-gem/[What is a Gem?]
|
60
|
+
* http://blog.teamtreehouse.com/short-introduction-minitest[How to use Minitest]
|
61
|
+
* http://www.rubyinside.com/a-minitestspec-tutorial-elegant-spec-style-testing-that-comes-with-ruby-5354.html[Minitest spec tutorial]
|
62
|
+
* https://github.com/seattlerb/minitest/blob/master/README.rdoc[Minitest Project Documentation]
|
63
|
+
|
64
|
+
While these resources don't cover everything needed they serve as a good starting off point for beginners.
|
65
|
+
|
66
|
+
=== Writing and Executing Tests
|
67
|
+
|
68
|
+
Tests live inside the test directory and are named <topic>_test.rb.
|
69
|
+
For instance, tests for the different types of blocks can be found in the file test/blocks_test.rb.
|
70
|
+
|
71
|
+
Within a test file, individual test cases are organized inside of contexts.
|
72
|
+
A context is type of logical container that groups related tests together.
|
73
|
+
|
74
|
+
Each test case follows the same structure:
|
75
|
+
|
76
|
+
[source]
|
77
|
+
----
|
78
|
+
test 'description of test' do
|
79
|
+
# test logic
|
80
|
+
end
|
81
|
+
----
|
82
|
+
|
83
|
+
At the moment, the tests are quite primitive.
|
84
|
+
Here's how a typical test operates:
|
85
|
+
|
86
|
+
. Defines sample AsciiDoc source
|
87
|
+
. Renders the document to HTML or DocBook
|
88
|
+
. Uses XPath and CSS expressions to verify expected output
|
89
|
+
|
90
|
+
Here's how we might test the open block syntax:
|
91
|
+
|
92
|
+
[source]
|
93
|
+
----
|
94
|
+
test 'should render content bounded by two consecutive hyphens as an open block' do
|
95
|
+
input = <<-EOS
|
96
|
+
--
|
97
|
+
This is an open block.
|
98
|
+
--
|
99
|
+
EOS
|
100
|
+
result = render_embedded_string input
|
101
|
+
assert_css '.openblock', result, 1
|
102
|
+
assert_css '.openblock p', result, 1
|
103
|
+
assert_xpath '/div[@class="openblock"]//p[text()="This is an open block."]', result, 1
|
104
|
+
end
|
105
|
+
----
|
106
|
+
|
107
|
+
As you can see, several helpers are used to facilitate the test scenario.
|
108
|
+
The `render_embedded_string` invokes Asciidoctor's render method with the header and footer option disabled.
|
109
|
+
This method is ideal for unit-level tests.
|
110
|
+
If you need to test the whole document, use `render_string` instead.
|
111
|
+
The `assert_css` and `assert_xpath` assertion methods take a CSS or XPath selector, respectively, the rendered result and the number of expected matches.
|
112
|
+
You can also use built-in assertions in Ruby's test library.
|
113
|
+
|
114
|
+
To run all the tests, simply execute `rake`:
|
115
|
+
|
116
|
+
$ rake
|
117
|
+
|
118
|
+
NOTE: The tests should only take a few seconds to run using Ruby 2.1.
|
119
|
+
|
120
|
+
If you want to run a single test file, you can use `ruby`:
|
121
|
+
|
122
|
+
$ ruby test/blocks_test.rb
|
123
|
+
|
124
|
+
To test a single test case, first add the string "wip" to the beginning of the description.
|
125
|
+
For example:
|
126
|
+
|
127
|
+
[source]
|
128
|
+
----
|
129
|
+
test 'wip should render ...' do
|
130
|
+
...
|
131
|
+
end
|
132
|
+
----
|
133
|
+
|
134
|
+
Then, run `ruby` again, but this time pass a selector argument so it finds matching tests:
|
135
|
+
|
136
|
+
$ ruby test/blocks_test.rb -n /wip/
|
137
|
+
|
138
|
+
You can also turn on verbose mode if you want to see more output:
|
139
|
+
|
140
|
+
$ ruby test/blocks_test.rb -n /wip/ -v
|
141
|
+
|
142
|
+
Once you are done with your test, make sure to remove `wip` from the description and run all the tests again using `rake`.
|
143
|
+
|
144
|
+
We plan on switching to a more elegant testing framework in the future, such as RSpec or Cucumber, in order to make the tests more clear and robust.
|
145
|
+
|
146
|
+
=== Running Asciidoctor in Development Mode
|
147
|
+
|
148
|
+
Asciidoctor is designed so that you can run the script directly out of the cloned repository.
|
149
|
+
Simply execute the `asciidoctor` command directly (referencing it either by relative or absolute path).
|
150
|
+
There's no need to install it using the `gem` command first.
|
151
|
+
|
152
|
+
For example, to convert the README file, switch to the root of the project and run:
|
153
|
+
|
154
|
+
$ ./bin/asciidoctor README.adoc
|
155
|
+
|
156
|
+
IMPORTANT: You'll need to make sure you reference the correct relative path to the `asciidoctor` command.
|
157
|
+
|
158
|
+
If you want to be able to execute the `asciidoctor` command from any directory without worrying about the relative (or absolute) path, you can setup the following Bash alias:
|
159
|
+
|
160
|
+
alias asciidoctor-dev="/path/to/asciidoctor/bin/asciidoctor"
|
161
|
+
|
162
|
+
Now you can execute the `asciidoctor` command from any folder as follows:
|
163
|
+
|
164
|
+
$ asciidoctor-dev README.adoc
|
165
|
+
|
166
|
+
== Supporting Additional Ruby Versions
|
167
|
+
|
168
|
+
If you would like this library to support another Ruby version, you may volunteer to be a maintainer.
|
169
|
+
Being a maintainer entails making sure all tests run and pass on that implementation.
|
170
|
+
When something breaks on your implementation, you will be expected to provide patches in a timely fashion.
|
171
|
+
If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.
|
data/LICENSE.adoc
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
.The MIT License
|
2
2
|
....
|
3
|
-
Copyright (C) 2012-
|
3
|
+
Copyright (C) 2012-2016 Dan Allen, Ryan Waldron and the Asciidoctor Project
|
4
4
|
|
5
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
6
|
of this software and associated documentation files (the "Software"), to deal
|
data/README.adoc
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
= Asciidoctor
|
2
2
|
Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>; Ryan Waldron <https://github.com/erebor[@erebor]>
|
3
|
-
v1.5.
|
3
|
+
v1.5.4, 2016-01-05
|
4
4
|
// settings:
|
5
5
|
:page-layout: base
|
6
6
|
:idprefix:
|
@@ -35,7 +35,8 @@ endif::[]
|
|
35
35
|
:uri-rubygem: https://rubygems.org/gems/asciidoctor
|
36
36
|
:uri-what-is-asciidoc: {uri-docs}/what-is-asciidoc
|
37
37
|
:uri-user-manual: {uri-docs}/user-manual
|
38
|
-
:uri-install-
|
38
|
+
:uri-install-docker: https://github.com/asciidoctor/docker-asciidoctor
|
39
|
+
//:uri-install-doc: {uri-docs}/install-toolchain
|
39
40
|
:uri-install-osx-doc: {uri-docs}/install-asciidoctor-macosx
|
40
41
|
:uri-render-doc: {uri-docs}/render-documents
|
41
42
|
:uri-themes-doc: {uri-docs}/produce-custom-themes-using-asciidoctor-stylesheet-factory
|
@@ -89,13 +90,13 @@ image::{image-uri-screenshot}[Preview of AsciiDoc source and corresponding rende
|
|
89
90
|
|
90
91
|
== AsciiDoc Processing
|
91
92
|
|
92
|
-
Asciidoctor reads and parses text written in the AsciiDoc syntax, then feeds the parse tree
|
93
|
-
You have the option of
|
93
|
+
Asciidoctor reads and parses text written in the AsciiDoc syntax, then feeds the parse tree to a set of built-in converters to produce HTML5, DocBook 5 (or 4.5) or man(ual) page output.
|
94
|
+
You have the option of using your own converter or loading {uri-tilt}[Tilt]-supported templates to customize the generated output or produce additional formats.
|
94
95
|
|
95
96
|
NOTE: Asciidoctor is a drop-in replacement for the original AsciiDoc Python processor (`asciidoc.py`).
|
96
97
|
The Asciidoctor test suite has {uri-tests}[> 1,600 tests] to ensure compatibility with the AsciiDoc syntax.
|
97
98
|
|
98
|
-
In addition to the
|
99
|
+
In addition to the classic AsciiDoc syntax, Asciidoctor recognizes additional markup and formatting options, such as font-based icons (e.g., `+icon:fire[]+`) and UI elements (e.g., `+button:[Save]+`).
|
99
100
|
Asciidoctor also offers a modern, responsive theme based on {uri-foundation}[Foundation] to style the HTML5 output.
|
100
101
|
|
101
102
|
== Requirements
|
@@ -190,8 +191,10 @@ TIP: Your Debian or Ubuntu system may be configured to automatically update pack
|
|
190
191
|
|
191
192
|
=== Other installation options
|
192
193
|
|
193
|
-
* {uri-install-
|
194
|
+
* {uri-install-docker}[Installing Asciidoctor using Docker]
|
194
195
|
* {uri-install-osx-doc}[Installing Asciidoctor on Mac OS X]
|
196
|
+
// at the moment, the following entry is just a reiteration of the information in this README
|
197
|
+
//* {uri-install-doc}[Installing the Asciidoctor toolchain]
|
195
198
|
|
196
199
|
== Usage
|
197
200
|
|
@@ -335,7 +338,7 @@ Asciidoctor organization on GitHub:: {uri-org}
|
|
335
338
|
|
336
339
|
== Copyright and Licensing
|
337
340
|
|
338
|
-
Copyright (C) 2012-
|
341
|
+
Copyright (C) 2012-2016 Dan Allen, Ryan Waldron and the Asciidoctor Project.
|
339
342
|
Free use of this software is granted under the terms of the MIT License.
|
340
343
|
|
341
344
|
See the {uri-license}[LICENSE] file for details.
|
@@ -349,6 +352,54 @@ The project was initiated in 2012 by https://github.com/erebor[Ryan Waldron] and
|
|
349
352
|
|
350
353
|
== Changelog
|
351
354
|
|
355
|
+
== 1.5.4 (2016-01-03) - @mojavelinux
|
356
|
+
|
357
|
+
Enhancements::
|
358
|
+
* translate README into French (@anthonny, @mogztter, @gscheibel, @mgreau) (#1630)
|
359
|
+
* allow linkstyle in manpage output to be configured (#1610)
|
360
|
+
|
361
|
+
Improvements::
|
362
|
+
* upgrade to MathJax 2.6.0 and disable loading messages
|
363
|
+
* upgrade to Font Awesome 4.5.0
|
364
|
+
* disable toc if document has no sections (#1633)
|
365
|
+
* convert inline asciimath to MathML (using asciimath gem) in DocBook converter (#1622)
|
366
|
+
* add attribute to control build reproducibility (@bk2204) (#1453)
|
367
|
+
* recognize \file:/// as a file root in Opal browser env (#1561)
|
368
|
+
* honor icon attribute on admonition block when font-based icons are enabled (@robertpanzer) (#1593)
|
369
|
+
* resolve custom icon relative to iconsdir; add file extension if absent (#1634)
|
370
|
+
* allow asciidoctor cli to resolve library path when invoked without leading ./
|
371
|
+
|
372
|
+
Compliance::
|
373
|
+
* allow special section to be nested at any depth (#1591)
|
374
|
+
* ensure colpcwidth values add up to 100%; increase precision of values to 4 decimal places (#1647)
|
375
|
+
* ignore blank cols attribute on table (#1647)
|
376
|
+
* support shorthand syntax for block attributes on document title (#1650)
|
377
|
+
|
378
|
+
Bug fixes::
|
379
|
+
* don't include default toc in AsciiDoc table cell; don't pass toc location attributes to nested document (#1582)
|
380
|
+
* guard against nil dlist list item in find_by (#1618)
|
381
|
+
* don't swallow trailing line when include file is not readable (#1602)
|
382
|
+
* change xlink namespace to xl in DocBook 5 output to prevent parse error (#1597)
|
383
|
+
* make callouts globally unique within document, including AsciiDoc table cells (#1626)
|
384
|
+
* initialize Slim-related attributes regardless of when Slim was loaded (@terceiro) (#1576)
|
385
|
+
* differentiate literal backslash from escape sequence in manpage output (@ds26gte) (#1604)
|
386
|
+
* don't mistake line beginning with \. for troff macro in manpage output (@ds26gte) (#1589)
|
387
|
+
* escape leading dots so user content doesn't trigger troff macros in manpage output (@ds26gte) (#1631)
|
388
|
+
* use \c after .URL macro to remove extraneous space in manpage output (@ds26gte) (#1590)
|
389
|
+
* fix missing endline after .URL macro in manpage output (#1613)
|
390
|
+
* properly handle spacing around .URL/.MTO macro in manpage output (@ds26gte) (#1641)
|
391
|
+
* don't swallow doctitle attribute followed by block title (#1587)
|
392
|
+
* change strategy for splitting names of author; fixes bug in Opal/Asciidoctor.js
|
393
|
+
* don't fail if library is loaded more than once
|
394
|
+
|
395
|
+
Infrastructure::
|
396
|
+
* remove trailing endlines in project source code
|
397
|
+
* update contributing guidelines
|
398
|
+
* explicitly test ifeval scenario raised in issue #1585
|
399
|
+
* remove backreference substitution hack for Opal/Asciidoctor.js
|
400
|
+
* fix assignment of default Hash value for Opal/Asciidoctor.js
|
401
|
+
* add JRuby 9.0.4.0 and Ruby 2.3.0 to the Travis CI build matrix
|
402
|
+
|
352
403
|
== 1.5.3 (2015-10-31) - @mojavelinux
|
353
404
|
|
354
405
|
Enhancements::
|
@@ -359,11 +410,12 @@ Enhancements::
|
|
359
410
|
* allow text of selected lines to be highlighted in source block by Pygments or CodeRay (#1429)
|
360
411
|
* use value of `docinfo` attribute to control docinfo behavior (#1510)
|
361
412
|
* add `docinfosubs` attribute to control which substitutions are performed on docinfo files (@mogztter) (#405)
|
362
|
-
*
|
413
|
+
* drop ability to specify multiple attributes with a single `-a` flag when using the CLI (@mogztter) (#405)
|
414
|
+
* make subtitle separator chars for document title configurable (@rmannibucau) (#1350)
|
363
415
|
* make XrefInlineRx regexp more permissive (Mathieu Boespflug) (#844)
|
364
416
|
|
365
417
|
Improvements::
|
366
|
-
* load JavaScript and CSS at
|
418
|
+
* load JavaScript and CSS at bottom of HTML document (@mogztter) (#1238)
|
367
419
|
* list available backends in help text (@plaindocs) (#1271)
|
368
420
|
* properly expand tabs in literal text (#1170, #841)
|
369
421
|
* add `source-indent` as document attribute (@mogztter) (#1169)
|
@@ -401,7 +453,7 @@ Improvements::
|
|
401
453
|
* document `-I` and `-r` options in the manual page (@bk2204)
|
402
454
|
* fix `+--help+` output text for `-I` (@bk2204)
|
403
455
|
* don't require open-uri-cached if already loaded
|
404
|
-
* do not attempt to scan pattern of non-existent directory
|
456
|
+
* do not attempt to scan pattern of non-existent directory in template converter
|
405
457
|
|
406
458
|
Compliance::
|
407
459
|
* use `<sup>` for footnote reference in text instead of `<span>` (#1523)
|
@@ -487,24 +539,4 @@ Bug fixes::
|
|
487
539
|
* fix includes that reference absolute Windows paths (#1144)
|
488
540
|
* apply DSL to extension block in a way compatible with Opal
|
489
541
|
|
490
|
-
== 1.5.1 (2014-09-29) - @mojavelinux
|
491
|
-
|
492
|
-
Bug fixes::
|
493
|
-
|
494
|
-
* recognize tag directives inside comments within XML files for including tagged regions
|
495
|
-
* restore passthroughs inside footnotes when more than one footnote appears on the same line
|
496
|
-
* -S flag in cli recognizes safe mode name as lowercase string
|
497
|
-
* do not match # in character reference when looking for marked text
|
498
|
-
* add namespace to lang attribute in DocBook 5 backend
|
499
|
-
* restore missing space before conum on last line of listing when highlighting with Pygments
|
500
|
-
* place conums on correct lines when line numbers are enabled when highlighting with Pygments
|
501
|
-
* don't expand mailto links in print styles
|
502
|
-
|
503
|
-
Improvements::
|
504
|
-
|
505
|
-
* implement File.read in Node (JavaScript) environment
|
506
|
-
* assign sectnumlevels and toclevels values to maxdepth attribute on AsciiDoc processing instructions in DocBook output
|
507
|
-
* add test for usage of image block macro with data URI
|
508
|
-
* use badges from shields.io in README
|
509
|
-
|
510
542
|
Refer to the {uri-changelog}[CHANGELOG] for a complete list of changes in older releases.
|