The following conventions are used:

For showing exactly what should be typed into the command line, a different font will be used as in the following example.

cd mydirectory

The following admonitions will be used to draw your attention.

Note
Notes are used to highlight important information or to present asides relevant to the topic at hand.
Tip
Tips provide helpful information on how to most effectively use a particular idea.
Warning
Warnings alert you to significant difficulties that may occur.
Caution
Cautions alert you to potential difficulties that may occur.

I will also show examples of AsciiDoc plain text. These examples will be formatted as plain text like the following example, sometimes including callouts that I use to describe a specific spot in the AsciiDoc plain text:

== My Chapter Title (1)
My first paragraph is here.
This is just an example paragraph, so there is nothing exciting about it.

My next paragraph is separated by a blank line to let the rendering app know that this is a new paragraph. (2)
So I can include other information in this paragraph that will be separate from the preceding paragraph.

=== My Section Title Goes Here (3)
Here is another example paragraph.
Blah blah blah.
  1. The chapter title only has two equal signs in front of the title.

  2. The paragraphs are separated by a blank line.

  3. The section title has three equals signs in front of the title.

Image

Line By Line

Here a Little, There a Little, Layer by Layer.

Back to Overview