|
| 1 | += AsciiDoc Article Title |
| 2 | +Firstname Lastname <author@asciidoctor.org> |
| 3 | +1.0, July 29, 2014, Asciidoctor 1.5 article template |
| 4 | +:toc: left |
| 5 | +:toclevels: 5 |
| 6 | +:icons: font |
| 7 | +:stem: latexmath |
| 8 | +:quick-uri: https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/ |
| 9 | + |
| 10 | +Content entered directly below the header but before the first section heading is called the preamble. |
| 11 | + |
| 12 | +== Text formatting |
| 13 | + |
| 14 | +This is a paragraph of regular text. |
| 15 | + |
| 16 | +This is a paragraph with a *bold* word and an _italicized_ word. *_Bold italic_* is also possible. |
| 17 | + |
| 18 | +Words can also have internal b**ol**d and it__ali__c formatting. |
| 19 | + |
| 20 | +Some constrained `monospace text`, and some ``u``nconstrained ``m``onospace ``t``ext. |
| 21 | + |
| 22 | +Some Superscript^®^ text and some subscript text: H~2~O. |
| 23 | + |
| 24 | +=== Links |
| 25 | + |
| 26 | +The text at the end of this sentence is cross referenced to <<_third_level_heading,the third level heading>> |
| 27 | + |
| 28 | +This is a link to the https://asciidoctor.org/docs/user-manual/[Asciidoctor User Manual^]. |
| 29 | + |
| 30 | +This is an attribute reference {quick-uri}[which links this text to the Asciidoctor Quick Reference Guide^]. |
| 31 | + |
| 32 | +=== Replacements |
| 33 | + |
| 34 | +* copyright: (C) |
| 35 | +* registered trademark: (R) |
| 36 | +* trademark: (TM) |
| 37 | +* em dash (between words): -- |
| 38 | +* ellipses: ... |
| 39 | +* arrows: -> => <- <= |
| 40 | +* apostrophe: Sam's |
| 41 | +* XML entity (e.g., dagger): † |
| 42 | + |
| 43 | +=== Math |
| 44 | + |
| 45 | +Find the area under the graph of \$y = x^2\$ between \$x= 1\$ and \$x = 2\$. |
| 46 | + |
| 47 | +\[ \int_1^2 x^2 dx = \left[ \frac{x^3}{3} \right]_1^2 = \frac{2^3}{3} - \frac{1^3}{3} = \frac{7}{3} \] |
| 48 | + |
| 49 | +== Images |
| 50 | + |
| 51 | +.Image caption |
| 52 | +image::resources/picture.jpg[This is the image alt text.] |
| 53 | + |
| 54 | +== Footnotes |
| 55 | + |
| 56 | +This is another paragraph.footnote:[This is footnote text and will be displayed at the bottom of the article.] |
| 57 | + |
| 58 | +== Headings |
| 59 | +=== Second level heading |
| 60 | +==== Third level heading |
| 61 | +===== Fourth level heading |
| 62 | +====== Fifth level heading |
| 63 | + |
| 64 | +== Lists |
| 65 | + |
| 66 | +=== Unordered lists |
| 67 | + |
| 68 | +.Unordered list title |
| 69 | +* list item 1 |
| 70 | +** nested list item |
| 71 | +*** nested nested list item 1 |
| 72 | +*** nested nested list item 2 |
| 73 | +* list item 2 |
| 74 | + |
| 75 | +=== Ordered lists |
| 76 | + |
| 77 | +.Ordered list title |
| 78 | +. ordered list item |
| 79 | +.. nested ordered list item |
| 80 | +. ordered list item |
| 81 | +.. second level list item |
| 82 | +... third level list item |
| 83 | +... another third level list item |
| 84 | +... a final third level list item |
| 85 | +.. another second level list item |
| 86 | + |
| 87 | +You can override the number scheme for any level by setting its style (the first positional entry in a block attribute list). You can also set the starting number using the start attribute: |
| 88 | + |
| 89 | +["lowerroman", start=5] |
| 90 | +. Five |
| 91 | +. Six |
| 92 | +[loweralpha] |
| 93 | +.. a |
| 94 | +.. b |
| 95 | +.. c |
| 96 | +. Seven |
| 97 | + |
| 98 | +=== Labelled lists |
| 99 | + |
| 100 | +Here's an example of a labeled list that identifies parts of a computer: |
| 101 | + |
| 102 | +CPU:: The brain of the computer. |
| 103 | +Hard drive:: Permanent storage for operating system and/or user files. |
| 104 | +RAM:: Temporarily stores information the CPU uses during operation. |
| 105 | +Keyboard:: Used to enter text or control items on the screen. |
| 106 | +Mouse:: Used to point to and select items on your computer screen. |
| 107 | +Monitor:: Displays information in visual form using text and graphics. |
| 108 | + |
| 109 | +.A horizontal labelled list |
| 110 | +[horizontal] |
| 111 | +CPU:: The brain of the computer. |
| 112 | +Hard drive:: Permanent storage for operating system and/or user files. |
| 113 | +RAM:: Temporarily stores information the CPU uses during operation. |
| 114 | + |
| 115 | +.Labelled list with bullets |
| 116 | +Diary:: |
| 117 | +* Milk |
| 118 | +* Eggs |
| 119 | +Bakery:: |
| 120 | +* Bread |
| 121 | +Produce:: |
| 122 | +* Bananas |
| 123 | + |
| 124 | +=== Mixed lists |
| 125 | + |
| 126 | +.Mixed unordered and ordered lists |
| 127 | +. Linux |
| 128 | +* Fedora |
| 129 | +* Ubuntu |
| 130 | +* Slackware |
| 131 | +. BSD |
| 132 | +* FreeBSD |
| 133 | +* NetBSD |
| 134 | + |
| 135 | +Here’s a list that mixes all three types of lists: |
| 136 | + |
| 137 | +Operating Systems:: |
| 138 | + . Linux |
| 139 | + * Fedora |
| 140 | + * Ubuntu |
| 141 | + * Slackware |
| 142 | + . BSD |
| 143 | + * FreeBSD |
| 144 | + * NetBSD |
| 145 | +Cloud Providers:: |
| 146 | + . PaaS |
| 147 | + * OpenShift |
| 148 | + * CloudBees |
| 149 | + . IaaS |
| 150 | + * Amazon EC2 |
| 151 | + * Rackspace |
| 152 | + |
| 153 | +== Blocks |
| 154 | + |
| 155 | +.Example block title |
| 156 | +==== |
| 157 | +Content in an example block is subject to normal substitutions. |
| 158 | +==== |
| 159 | + |
| 160 | +.Sidebar title |
| 161 | +**** |
| 162 | +Sidebars contain aside text and are subject to normal substitutions. |
| 163 | +**** |
| 164 | + |
| 165 | +[#id-for-listing-block] |
| 166 | +.Listing block title |
| 167 | +---- |
| 168 | +Content in a listing block is subject to verbatim substitutions. |
| 169 | +Listing block content is commonly used to preserve code input. |
| 170 | +---- |
| 171 | + |
| 172 | +== Tables |
| 173 | + |
| 174 | +.A simple table with a title |
| 175 | +|=== |
| 176 | +|Column heading 1 |Column heading 2 |
| 177 | + |
| 178 | +|Column 1, row 1 |
| 179 | +|Column 2, row 1 |
| 180 | + |
| 181 | +|Column 1, row 2 |
| 182 | +|Column 2, row 2 |
| 183 | +|=== |
| 184 | + |
| 185 | +==== |
| 186 | +.A table containing another nested table |
| 187 | +[cols=".^,<.^a,>.^a"] |
| 188 | +|=== |
| 189 | +| \[X_nY_m\] |
| 190 | +| * \(X\) a ante \(i\) |
| 191 | +* \(Y\) a ante \(j\) |
| 192 | +| [cols=">.^"] |
| 193 | +!=== |
| 194 | +! Trad. ! Stock. ! Esteq. |
| 195 | +!=== |
| 196 | +|=== |
| 197 | +==== |
| 198 | + |
| 199 | + |
| 200 | +== Quotes |
| 201 | + |
| 202 | +[quote, firstname lastname, movie title] |
| 203 | +____ |
| 204 | +This is a block quote or a prose excerpt. |
| 205 | +This is subject to normal substitutions. |
| 206 | +____ |
| 207 | + |
| 208 | +[verse, firstname lastname, poem title and more] |
| 209 | +____ |
| 210 | +This is a verse block. |
| 211 | + Indents and endlines are preserved in verse blocks. |
| 212 | +____ |
| 213 | + |
| 214 | +== Admonitions |
| 215 | + |
| 216 | +TIP: This is a tip. There are five admonition labels: Tip, Note, Important, Caution and Warning. |
| 217 | + |
| 218 | +NOTE: This is a note. |
| 219 | + |
| 220 | +IMPORTANT: This is important. |
| 221 | + |
| 222 | +CAUTION: Caution -- be careful! |
| 223 | + |
| 224 | +WARNING: This is a warning. |
| 225 | + |
| 226 | +=== Admonition blocks |
| 227 | + |
| 228 | +[NOTE] |
| 229 | +.A "NOTE" type admonition |
| 230 | +==== |
| 231 | +This is an example of an admonition block. |
| 232 | +
|
| 233 | +Unlike an admonition paragraph, it may contain any AsciiDoc content. |
| 234 | +The style can be any one of the admonition labels: |
| 235 | +
|
| 236 | +* NOTE |
| 237 | +* TIP |
| 238 | +* WARNING |
| 239 | +* CAUTION |
| 240 | +* IMPORTANT |
| 241 | +==== |
| 242 | + |
| 243 | + |
| 244 | +// This is a comment and won't be rendered. |
| 245 | + |
| 246 | +// Based on https://github.com/asciidoctor/asciidoctor.org/blob/master/docs/_includes/asciidoc-article-template.adoc[Asciidoctor article template] and the https://asciidoctor.org/docs/asciidoc-writers-guide/[AsaciiDoc Writer's Guide] |
| 247 | + |
0 commit comments