...
See the AsciiDoctor Writer's Guide for more information https://asciidoctor.org/docs/asciidoc-writers-guide/
Tip: In general we should make the tutorials be less wordy, less long paragraphs.
Special Constructs and Best Practices
...
[.feature]
-- image::images/the-title-of-the-image-small.png[role="left", title="Click to enlarge", link="images/the-title-of-the-image-big.png"] --
Tip: Be sure to add a newline before the [.feature]
tag
Youtube videos
Use the "video" asciidoc macro to embed youtube videos, like so:
...
Other languages are "html", "xml", "javascript", "php", "python", "ruby". Remember to use the ":syntax: true" atribute in the metadata so that syntax highlighting works.
Restarting numbered lists
Numbered lists that have in-between paragraphs often restart numbering. So, for instance, you have item 1, item 2, then a paragraph and then the next item starts again at 1. Remember that you can tell asciidoc to start a numbered list on a certain number using the "start" tag, like so:
1. This is the first item
2. This is the second item
Now we have a paragraph here, or an image or whatever
[start=3]
3. This is the third item
Admonitions
Use NOTE: and TIP: for admonitions. These must be in capital letters, without any asterkisks around them:
NOTE: This is a note
If you use these admonitions be sure to add the
:icons: font
on the metadata of the page, so that admonitions have proper icons.
Icons
To use font awesome icons in your webpage include the :icons: font
in the metadata of the page.
...