asciidoctor 1.5.8 → 2.0.17

Sign up to get free protection for your applications and to get access to all the features.
Files changed (197) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +11 -0
  3. data/CHANGELOG.adoc +628 -45
  4. data/LICENSE +2 -1
  5. data/README-de.adoc +28 -38
  6. data/README-fr.adoc +30 -43
  7. data/README-jp.adoc +255 -201
  8. data/README-zh_CN.adoc +40 -44
  9. data/README.adoc +170 -143
  10. data/asciidoctor.gemspec +22 -34
  11. data/bin/asciidoctor +5 -4
  12. data/data/locale/attributes-ar.adoc +4 -3
  13. data/data/locale/attributes-be.adoc +23 -0
  14. data/data/locale/attributes-bg.adoc +4 -3
  15. data/data/locale/attributes-ca.adoc +6 -5
  16. data/data/locale/attributes-cs.adoc +4 -3
  17. data/data/locale/attributes-da.adoc +6 -5
  18. data/data/locale/attributes-de.adoc +6 -5
  19. data/data/locale/attributes-en.adoc +4 -4
  20. data/data/locale/attributes-es.adoc +6 -5
  21. data/data/locale/attributes-fa.adoc +4 -3
  22. data/data/locale/attributes-fi.adoc +4 -3
  23. data/data/locale/attributes-fr.adoc +8 -7
  24. data/data/locale/attributes-hu.adoc +4 -3
  25. data/data/locale/attributes-id.adoc +4 -3
  26. data/data/locale/attributes-it.adoc +6 -5
  27. data/data/locale/attributes-ja.adoc +4 -3
  28. data/data/locale/{attributes-kr.adoc → attributes-ko.adoc} +4 -3
  29. data/data/locale/attributes-nb.adoc +4 -3
  30. data/data/locale/attributes-nl.adoc +6 -5
  31. data/data/locale/attributes-nn.adoc +4 -3
  32. data/data/locale/attributes-pl.adoc +8 -7
  33. data/data/locale/attributes-pt.adoc +6 -5
  34. data/data/locale/attributes-pt_BR.adoc +6 -5
  35. data/data/locale/attributes-ro.adoc +4 -3
  36. data/data/locale/attributes-ru.adoc +6 -5
  37. data/data/locale/attributes-sr.adoc +4 -4
  38. data/data/locale/attributes-sr_Latn.adoc +4 -4
  39. data/data/locale/attributes-sv.adoc +4 -4
  40. data/data/locale/attributes-th.adoc +23 -0
  41. data/data/locale/attributes-tr.adoc +4 -3
  42. data/data/locale/attributes-uk.adoc +6 -5
  43. data/data/locale/attributes-vi.adoc +23 -0
  44. data/data/locale/attributes-zh_CN.adoc +4 -3
  45. data/data/locale/attributes-zh_TW.adoc +4 -3
  46. data/data/reference/syntax.adoc +296 -0
  47. data/data/stylesheets/asciidoctor-default.css +120 -114
  48. data/data/stylesheets/coderay-asciidoctor.css +15 -17
  49. data/lib/asciidoctor/abstract_block.rb +146 -140
  50. data/lib/asciidoctor/abstract_node.rb +152 -170
  51. data/lib/asciidoctor/attribute_list.rb +77 -89
  52. data/lib/asciidoctor/block.rb +29 -28
  53. data/lib/asciidoctor/callouts.rb +4 -2
  54. data/lib/asciidoctor/cli/invoker.rb +20 -24
  55. data/lib/asciidoctor/cli/options.rb +107 -96
  56. data/lib/asciidoctor/cli.rb +3 -2
  57. data/lib/asciidoctor/convert.rb +199 -0
  58. data/lib/asciidoctor/converter/composite.rb +40 -48
  59. data/lib/asciidoctor/converter/docbook5.rb +627 -644
  60. data/lib/asciidoctor/converter/html5.rb +1053 -951
  61. data/lib/asciidoctor/converter/manpage.rb +581 -532
  62. data/lib/asciidoctor/converter/template.rb +232 -271
  63. data/lib/asciidoctor/converter.rb +370 -185
  64. data/lib/asciidoctor/core_ext/float/truncate.rb +20 -0
  65. data/lib/asciidoctor/core_ext/hash/merge.rb +8 -0
  66. data/lib/asciidoctor/core_ext/match_data/names.rb +7 -0
  67. data/lib/asciidoctor/core_ext/nil_or_empty.rb +1 -0
  68. data/lib/asciidoctor/core_ext/regexp/is_match.rb +4 -2
  69. data/lib/asciidoctor/core_ext.rb +8 -17
  70. data/lib/asciidoctor/document.rb +503 -461
  71. data/lib/asciidoctor/extensions.rb +127 -174
  72. data/lib/asciidoctor/helpers.rb +184 -107
  73. data/lib/asciidoctor/inline.rb +9 -12
  74. data/lib/asciidoctor/list.rb +11 -29
  75. data/lib/asciidoctor/load.rb +119 -0
  76. data/lib/asciidoctor/logging.rb +22 -17
  77. data/lib/asciidoctor/parser.rb +673 -719
  78. data/lib/asciidoctor/path_resolver.rb +48 -33
  79. data/lib/asciidoctor/reader.rb +383 -338
  80. data/lib/asciidoctor/rouge_ext.rb +39 -0
  81. data/lib/asciidoctor/rx.rb +723 -0
  82. data/lib/asciidoctor/section.rb +17 -16
  83. data/lib/asciidoctor/stylesheets.rb +19 -37
  84. data/lib/asciidoctor/substitutors.rb +926 -1022
  85. data/lib/asciidoctor/syntax_highlighter/coderay.rb +88 -0
  86. data/lib/asciidoctor/syntax_highlighter/highlightjs.rb +34 -0
  87. data/lib/asciidoctor/syntax_highlighter/html_pipeline.rb +10 -0
  88. data/lib/asciidoctor/syntax_highlighter/prettify.rb +30 -0
  89. data/lib/asciidoctor/syntax_highlighter/pygments.rb +157 -0
  90. data/lib/asciidoctor/syntax_highlighter/rouge.rb +143 -0
  91. data/lib/asciidoctor/syntax_highlighter.rb +253 -0
  92. data/lib/asciidoctor/table.rb +152 -114
  93. data/lib/asciidoctor/timings.rb +7 -5
  94. data/lib/asciidoctor/version.rb +2 -1
  95. data/lib/asciidoctor/writer.rb +30 -0
  96. data/lib/asciidoctor.rb +266 -1340
  97. data/man/asciidoctor.1 +49 -47
  98. data/man/asciidoctor.adoc +54 -45
  99. metadata +50 -245
  100. data/CONTRIBUTING.adoc +0 -185
  101. data/Gemfile +0 -60
  102. data/Rakefile +0 -129
  103. data/bin/asciidoctor-safe +0 -15
  104. data/features/open_block.feature +0 -92
  105. data/features/pass_block.feature +0 -66
  106. data/features/step_definitions.rb +0 -49
  107. data/features/text_formatting.feature +0 -57
  108. data/features/xref.feature +0 -1039
  109. data/lib/asciidoctor/converter/base.rb +0 -59
  110. data/lib/asciidoctor/converter/docbook45.rb +0 -93
  111. data/lib/asciidoctor/converter/factory.rb +0 -226
  112. data/lib/asciidoctor/core_ext/1.8.7/base64/strict_encode64.rb +0 -6
  113. data/lib/asciidoctor/core_ext/1.8.7/concurrent/hash.rb +0 -5
  114. data/lib/asciidoctor/core_ext/1.8.7/hash/key.rb +0 -4
  115. data/lib/asciidoctor/core_ext/1.8.7/io/binread.rb +0 -6
  116. data/lib/asciidoctor/core_ext/1.8.7/io/write.rb +0 -5
  117. data/lib/asciidoctor/core_ext/1.8.7/string/chr.rb +0 -6
  118. data/lib/asciidoctor/core_ext/1.8.7/string/limit_bytesize.rb +0 -29
  119. data/lib/asciidoctor/core_ext/1.8.7/symbol/empty.rb +0 -6
  120. data/lib/asciidoctor/core_ext/1.8.7/symbol/length.rb +0 -6
  121. data/lib/asciidoctor/core_ext/string/limit_bytesize.rb +0 -10
  122. data/test/api_test.rb +0 -1240
  123. data/test/attribute_list_test.rb +0 -242
  124. data/test/attributes_test.rb +0 -1623
  125. data/test/blocks_test.rb +0 -3870
  126. data/test/converter_test.rb +0 -470
  127. data/test/document_test.rb +0 -1853
  128. data/test/extensions_test.rb +0 -1560
  129. data/test/fixtures/asciidoc_index.txt +0 -521
  130. data/test/fixtures/basic-docinfo-footer.html +0 -6
  131. data/test/fixtures/basic-docinfo-footer.xml +0 -8
  132. data/test/fixtures/basic-docinfo.html +0 -1
  133. data/test/fixtures/basic-docinfo.xml +0 -4
  134. data/test/fixtures/basic.asciidoc +0 -5
  135. data/test/fixtures/chapter-a.adoc +0 -3
  136. data/test/fixtures/child-include.adoc +0 -5
  137. data/test/fixtures/circle.svg +0 -9
  138. data/test/fixtures/custom-backends/erb/html5/block_paragraph.html.erb +0 -6
  139. data/test/fixtures/custom-backends/haml/docbook45/block_paragraph.xml.haml +0 -6
  140. data/test/fixtures/custom-backends/haml/html5/block_paragraph.html.haml +0 -3
  141. data/test/fixtures/custom-backends/haml/html5/block_sidebar.html.haml +0 -5
  142. data/test/fixtures/custom-backends/haml/html5-tweaks/block_paragraph.html.haml +0 -1
  143. data/test/fixtures/custom-backends/slim/docbook45/block_paragraph.xml.slim +0 -6
  144. data/test/fixtures/custom-backends/slim/html5/block_paragraph.html.slim +0 -3
  145. data/test/fixtures/custom-backends/slim/html5/block_sidebar.html.slim +0 -5
  146. data/test/fixtures/custom-docinfodir/basic-docinfo.html +0 -1
  147. data/test/fixtures/custom-docinfodir/docinfo.html +0 -1
  148. data/test/fixtures/docinfo-footer.html +0 -1
  149. data/test/fixtures/docinfo-footer.xml +0 -9
  150. data/test/fixtures/docinfo.html +0 -1
  151. data/test/fixtures/docinfo.xml +0 -3
  152. data/test/fixtures/doctime-localtime.adoc +0 -2
  153. data/test/fixtures/dot.gif +0 -0
  154. data/test/fixtures/encoding.asciidoc +0 -13
  155. data/test/fixtures/file-with-missing-include.adoc +0 -1
  156. data/test/fixtures/grandchild-include.adoc +0 -3
  157. data/test/fixtures/hello-asciidoctor.pdf +0 -69
  158. data/test/fixtures/include-file.asciidoc +0 -24
  159. data/test/fixtures/include-file.jsx +0 -8
  160. data/test/fixtures/include-file.ml +0 -3
  161. data/test/fixtures/include-file.xml +0 -5
  162. data/test/fixtures/lists.adoc +0 -96
  163. data/test/fixtures/master.adoc +0 -5
  164. data/test/fixtures/mismatched-end-tag.adoc +0 -7
  165. data/test/fixtures/other-chapters.adoc +0 -11
  166. data/test/fixtures/outer-include.adoc +0 -5
  167. data/test/fixtures/parent-include-restricted.adoc +0 -5
  168. data/test/fixtures/parent-include.adoc +0 -5
  169. data/test/fixtures/sample.asciidoc +0 -30
  170. data/test/fixtures/section-a.adoc +0 -4
  171. data/test/fixtures/stylesheets/custom.css +0 -3
  172. data/test/fixtures/subdir/index.adoc +0 -3
  173. data/test/fixtures/subdir/inner-include.adoc +0 -3
  174. data/test/fixtures/subdir/middle-include.adoc +0 -5
  175. data/test/fixtures/subs-docinfo.html +0 -2
  176. data/test/fixtures/subs.adoc +0 -6
  177. data/test/fixtures/tagged-class-enclosed.rb +0 -25
  178. data/test/fixtures/tagged-class.rb +0 -23
  179. data/test/fixtures/tip.gif +0 -0
  180. data/test/fixtures/unclosed-tag.adoc +0 -3
  181. data/test/fixtures/unexpected-end-tag.adoc +0 -4
  182. data/test/invoker_test.rb +0 -745
  183. data/test/links_test.rb +0 -855
  184. data/test/lists_test.rb +0 -5151
  185. data/test/logger_test.rb +0 -211
  186. data/test/manpage_test.rb +0 -660
  187. data/test/options_test.rb +0 -262
  188. data/test/paragraphs_test.rb +0 -562
  189. data/test/parser_test.rb +0 -742
  190. data/test/paths_test.rb +0 -395
  191. data/test/preamble_test.rb +0 -173
  192. data/test/reader_test.rb +0 -2161
  193. data/test/sections_test.rb +0 -3575
  194. data/test/substitutions_test.rb +0 -2066
  195. data/test/tables_test.rb +0 -2036
  196. data/test/test_helper.rb +0 -447
  197. data/test/text_test.rb +0 -309
@@ -0,0 +1,23 @@
1
+ // Thai translation
2
+ :appendix-caption: อ้างอิง
3
+ :appendix-refsig: {appendix-caption}
4
+ :caution-caption: ระวัง
5
+ :chapter-signifier: บท
6
+ :chapter-refsig: {chapter-signifier}
7
+ :example-caption: ตัวอย่าง
8
+ :figure-caption: คำอธิบายลักษณะจำลอง
9
+ :important-caption: สำคัญ
10
+ :last-update-label: ตัวอัพเดตล่าสุด
11
+ ifdef::listing-caption[:listing-caption: รายการ]
12
+ ifdef::manname-title[:manname-title: ซื่อ]
13
+ :note-caption: บันทึก
14
+ :part-signifier: ส่วน
15
+ :part-refsig: {part-signifier}
16
+ ifdef::preface-title[:preface-title: คำนำ]
17
+ :section-refsig: รายการย่อย
18
+ :table-caption: ตาราง
19
+ :tip-caption: เคล็ดลับ
20
+ :toc-title: สารบัญ
21
+ :untitled-label: ยังไม่มีชื่อ
22
+ :version-label: เวอร์ชัน
23
+ :warning-caption: คำเตือน
@@ -2,8 +2,8 @@
2
2
  :appendix-caption: Ek bölüm
3
3
  :appendix-refsig: {appendix-caption}
4
4
  :caution-caption: Dikkat
5
- //:chapter-label: ???
6
- //:chapter-refsig: {chapter-label}
5
+ //:chapter-signifier: ???
6
+ //:chapter-refsig: {chapter-signifier}
7
7
  :example-caption: Örnek
8
8
  :figure-caption: Görsel
9
9
  :important-caption: Önemli
@@ -11,7 +11,8 @@
11
11
  ifdef::listing-caption[:listing-caption: Listeleme]
12
12
  ifdef::manname-title[:manname-title: İsim]
13
13
  :note-caption: Not
14
- //:part-refsig: ???
14
+ //:part-signifier: ???
15
+ //:part-refsig: {part-signifier}
15
16
  ifdef::preface-title[:preface-title: Ön söz]
16
17
  //:section-refsig: ???
17
18
  :table-caption: Tablo
@@ -2,18 +2,19 @@
2
2
  :appendix-caption: Додаток
3
3
  :appendix-refsig: {appendix-caption}
4
4
  :caution-caption: Обережно
5
- //:chapter-label: ???
6
- //:chapter-refsig: {chapter-label}
5
+ :chapter-signifier: Розділ
6
+ :chapter-refsig: {chapter-signifier}
7
7
  :example-caption: Приклад
8
- :figure-caption: Зображення
8
+ :figure-caption: Рисунок
9
9
  :important-caption: Важливо
10
10
  :last-update-label: Востаннє оновлено
11
11
  ifdef::listing-caption[:listing-caption: Лістинг]
12
12
  ifdef::manname-title[:manname-title: Назва]
13
13
  :note-caption: Зауваження
14
- //:part-refsig: ???
14
+ :part-signifier: Частина
15
+ :part-refsig: {part-signifier}
15
16
  ifdef::preface-title[:preface-title: Передмова]
16
- //:section-refsig: ???
17
+ :section-refsig: Підрозділ
17
18
  :table-caption: Таблиця
18
19
  :tip-caption: Підказка
19
20
  :toc-title: Зміст
@@ -0,0 +1,23 @@
1
+ // Vietnamese translation, courtesy of Hoa Nguyen <ntthoa.uphcm@gmail.com>
2
+ :appendix-caption: Phụ lục
3
+ :appendix-refsig: {appendix-caption}
4
+ :caution-caption: Cảnh báo
5
+ :chapter-signifier: Chương
6
+ :chapter-refsig: {chapter-signifier}
7
+ :example-caption: Ví dụ
8
+ :figure-caption: Hình
9
+ :important-caption: Quan trọng
10
+ :last-update-label: Cập nhật lần cuối
11
+ ifdef::listing-caption[:listing-caption: Danh sách]
12
+ ifdef::manname-title[:manname-title: Tên]
13
+ :note-caption: Ghi chú
14
+ :part-signifier: Phần
15
+ :part-refsig: {part-signifier}
16
+ ifdef::preface-title[:preface-title: Lời nói đầu]
17
+ :section-refsig: Mục
18
+ :table-caption: Bảng
19
+ :tip-caption: Lời khuyên
20
+ :toc-title: Mục lục
21
+ :untitled-label: Không có tiêu đề
22
+ :version-label: Phiên bản
23
+ :warning-caption: Chú ý
@@ -2,8 +2,8 @@
2
2
  :appendix-caption: 附录
3
3
  :appendix-refsig: {appendix-caption}
4
4
  :caution-caption: 注意
5
- //:chapter-label: ???
6
- //:chapter-refsig: {chapter-label}
5
+ //:chapter-signifier: ???
6
+ //:chapter-refsig: {chapter-signifier}
7
7
  :example-caption: 示例
8
8
  :figure-caption: 图表
9
9
  :important-caption: 重要
@@ -11,7 +11,8 @@
11
11
  ifdef::listing-caption[:listing-caption: 列表]
12
12
  ifdef::manname-title[:manname-title: 名称]
13
13
  :note-caption: 笔记
14
- //:part-refsig: ???
14
+ //:part-signifier: ???
15
+ //:part-refsig: {part-signifier}
15
16
  ifdef::preface-title[:preface-title: 序言]
16
17
  //:section-refsig: ???
17
18
  :table-caption: 表格
@@ -2,8 +2,8 @@
2
2
  :appendix-caption: 附錄
3
3
  :appendix-refsig: {appendix-caption}
4
4
  :caution-caption: 注意
5
- //:chapter-label: ???
6
- //:chapter-refsig: {chapter-label}
5
+ //:chapter-signifier: ???
6
+ //:chapter-refsig: {chapter-signifier}
7
7
  :example-caption: 示例
8
8
  :figure-caption: 圖表
9
9
  :important-caption: 重要
@@ -11,7 +11,8 @@
11
11
  ifdef::listing-caption[:listing-caption: 列表]
12
12
  ifdef::manname-title[:manname-title: 名稱]
13
13
  :note-caption: 筆記
14
- //:part-refsig: ???
14
+ //:part-signifier: ???
15
+ //:part-refsig: {part-signifier}
15
16
  ifdef::preface-title[:preface-title: 序言]
16
17
  //:section-refsig: ???
17
18
  :table-caption: 表格
@@ -0,0 +1,296 @@
1
+ = AsciiDoc Syntax
2
+ :icons: font
3
+ :stem:
4
+ :toc: left
5
+ :url-docs: https://asciidoctor.org/docs
6
+ :url-gem: https://rubygems.org/gems/asciidoctor
7
+
8
+ A brief reference of the most commonly used AsciiDoc syntax.
9
+ You can find the full documentation for the AsciiDoc syntax at {url-docs}.
10
+
11
+ == Paragraphs
12
+
13
+ A normal paragraph.
14
+ Line breaks are not preserved.
15
+ // line comments, which are lines that start with //, are skipped
16
+
17
+ A blank line separates paragraphs.
18
+
19
+ [%hardbreaks]
20
+ This paragraph is marked with the `hardbreaks` option.
21
+ Notice how line breaks are now preserved.
22
+
23
+ An indented (literal) paragraph disables text formatting,
24
+ preserves spaces and line breaks, and is displayed in a
25
+ monospaced font.
26
+
27
+ [sidebar#id.role]
28
+ Adding a style, ID, and/or role gives a paragraph (or block) special meaning, like this sidebar.
29
+
30
+ NOTE: An admonition paragraph, like this note, grabs the reader's attention.
31
+
32
+ TIP: Convert this document using the `asciidoctor` command to see the output produced from it.
33
+
34
+ == Text Formatting
35
+ :hardbreaks-option:
36
+
37
+ .Constrained (applied at word boundaries)
38
+ *strong importance* (aka bold)
39
+ _stress emphasis_ (aka italic)
40
+ `monospaced` (aka typewriter text)
41
+ "`double`" and '`single`' typographic quotes
42
+ +passthrough text+ (substitutions disabled)
43
+ `+literal text+` (monospaced with substitutions disabled)
44
+ a #mark# to remember (highlighted for notation)
45
+
46
+ .Unconstrained (applied anywhere)
47
+ **C**reate, **R**ead, **U**pdate, and **D**elete (CRUD)
48
+ fan__freakin__tastic
49
+ ``mono``culture
50
+ ##mark##up your text
51
+
52
+ .Replacements
53
+ A long time ago in a galaxy far, far away...
54
+ (C) 1976 Arty Artisan
55
+ I believe I shall--no, actually I won't.
56
+
57
+ .ID and roles for phrases
58
+ [.line-through]#delete me#
59
+ the [.path]_images_ directory
60
+ a [#wibble.term]*wibble* does wobble
61
+
62
+ .Macros
63
+ // where c=specialchars, q=quotes, a=attributes, r=replacements, m=macros, p=post_replacements, etc.
64
+ The European icon:flag[role=blue] is blue & contains pass:[************] arranged in a icon:circle-o[role=yellow].
65
+ The pass:c[->] operator is often referred to as the stabby lambda.
66
+ Since `pass:[++]` has strong priority in AsciiDoc, you can rewrite pass:c,a,r[C++ => C{pp}].
67
+ // activate stem support by adding `:stem:` to the document header
68
+ stem:[sqrt(4) = 2]
69
+
70
+ :!hardbreaks-option:
71
+ == Attributes
72
+
73
+ // define attributes in the document header; must be flush with left margin
74
+ :name: value
75
+
76
+ You can download and install Asciidoctor {asciidoctor-version} from {url-gem}.
77
+ C{pp} is not required, only Ruby.
78
+ Use a leading backslash to output a word enclosed in curly braces, like \{name}.
79
+
80
+ == Links
81
+
82
+ [%hardbreaks]
83
+ https://example.org/page[A webpage]
84
+ link:../path/to/file.txt[A local file]
85
+ xref:document.adoc[A sibling document]
86
+ mailto:hello@example.org[Email to say hello!]
87
+
88
+ == Anchors
89
+
90
+ [[idname,reference text]]
91
+ // or written using normal block attributes as `[#idname,reftext=reference text]`
92
+ A paragraph (or any block) with an anchor (aka ID) and reftext.
93
+
94
+ See <<idname>> or <<idname,optional text of internal link>>.
95
+
96
+ xref:document.adoc#idname[Jumps to anchor in another document].
97
+
98
+ This paragraph has a footnote.footnote:[This is the text of the footnote.]
99
+
100
+ == Lists
101
+
102
+ === Unordered
103
+
104
+ * level 1
105
+ ** level 2
106
+ *** level 3
107
+ **** level 4
108
+ ***** etc.
109
+ * back at level 1
110
+ +
111
+ Attach a block or paragraph to a list item using a list continuation (which you can enclose in an open block).
112
+
113
+ .Some Authors
114
+ [circle]
115
+ - Edgar Allen Poe
116
+ - Sheri S. Tepper
117
+ - Bill Bryson
118
+
119
+ === Ordered
120
+
121
+ . Step 1
122
+ . Step 2
123
+ .. Step 2a
124
+ .. Step 2b
125
+ . Step 3
126
+
127
+ .Remember your Roman numerals?
128
+ [upperroman]
129
+ . is one
130
+ . is two
131
+ . is three
132
+
133
+ === Checklist
134
+
135
+ * [x] checked
136
+ * [ ] not checked
137
+
138
+ === Callout
139
+
140
+ // enable callout bubbles by adding `:icons: font` to the document header
141
+ [,ruby]
142
+ ----
143
+ puts 'Hello, World!' # <1>
144
+ ----
145
+ <1> Prints `Hello, World!` to the console.
146
+
147
+ === Description
148
+
149
+ first term:: description of first term
150
+ second term::
151
+ description of second term
152
+
153
+ == Document Structure
154
+
155
+ === Header
156
+
157
+ // header must be flush with left margin
158
+ = Document Title
159
+ Author Name <author@example.org>
160
+ v1.0, 2019-01-01
161
+
162
+ === Sections
163
+
164
+ // must be flush with left margin
165
+ = Document Title (Level 0)
166
+ == Level 1
167
+ === Level 2
168
+ ==== Level 3
169
+ ===== Level 4
170
+ ====== Level 5
171
+ == Back at Level 1
172
+
173
+ === Includes
174
+
175
+ // must be flush with left margin
176
+ include::basics.adoc[]
177
+
178
+ // define -a allow-uri-read to allow content to be read from URI
179
+ include::https://example.org/installation.adoc[]
180
+
181
+ == Blocks
182
+
183
+ --
184
+ open - a general-purpose content wrapper; useful for enclosing content to attach to a list item
185
+ --
186
+
187
+ // recognized types include CAUTION, IMPORTANT, NOTE, TIP, and WARNING
188
+ // enable admonition icons by setting `:icons: font` in the document header
189
+ [NOTE]
190
+ ====
191
+ admonition - a notice for the reader, ranging in severity from a tip to an alert
192
+ ====
193
+
194
+ ====
195
+ example - a demonstration of the concept being documented
196
+ ====
197
+
198
+ .Toggle Me
199
+ [%collapsible]
200
+ ====
201
+ collapsible - these details are revealed by clicking the title
202
+ ====
203
+
204
+ ****
205
+ sidebar - auxiliary content that can be read independently of the main content
206
+ ****
207
+
208
+ ....
209
+ literal - an exhibit that features program output
210
+ ....
211
+
212
+ ----
213
+ listing - an exhibit that features program input, source code, or the contents of a file
214
+ ----
215
+
216
+ [,language]
217
+ ----
218
+ source - a listing that is embellished with (colorized) syntax highlighting
219
+ ----
220
+
221
+ ```language
222
+ fenced code - a shorthand syntax for the source block
223
+ ```
224
+
225
+ [,attribution,citetitle]
226
+ ____
227
+ quote - a quotation or excerpt; attribution with title of source are optional
228
+ ____
229
+
230
+ [verse,attribution,citetitle]
231
+ ____
232
+ verse - a literary excerpt, often a poem; attribution with title of source are optional
233
+ ____
234
+
235
+ ++++
236
+ pass - content passed directly to the output document; often raw HTML
237
+ ++++
238
+
239
+ // activate stem support by adding `:stem:` to the document header
240
+ [stem]
241
+ ++++
242
+ x = y^2
243
+ ++++
244
+
245
+ ////
246
+ comment - content which is not included in the output document
247
+ ////
248
+
249
+ == Tables
250
+
251
+ .Table Attributes
252
+ [cols=>1h;2d,width=50%,frame=ends]
253
+ |===
254
+ | Attribute Name | Values
255
+
256
+ | options
257
+ | header,footer,autowidth
258
+
259
+ | cols
260
+ | colspec[;colspec;...]
261
+
262
+ | grid
263
+ | all \| cols \| rows \| none
264
+
265
+ | frame
266
+ | all \| sides \| ends \| none
267
+
268
+ | stripes
269
+ | all \| even \| odd \| none
270
+
271
+ | width
272
+ | (0%..100%)
273
+
274
+ | format
275
+ | psv {vbar} csv {vbar} dsv
276
+ |===
277
+
278
+ == Multimedia
279
+
280
+ image::screenshot.png[block image,800,450]
281
+
282
+ Press image:reload.svg[reload,16,opts=interactive] to reload the page.
283
+
284
+ video::movie.mp4[width=640,start=60,end=140,options=autoplay]
285
+
286
+ video::aHjpOzsQ9YI[youtube]
287
+
288
+ video::300817511[vimeo]
289
+
290
+ == Breaks
291
+
292
+ // thematic break (aka horizontal rule)
293
+ ---
294
+
295
+ // page break
296
+ <<<