asciidoc-reference.adoc

AsciiDoctor Reference

AsciiDoc Documentation

This document is an ok primer on the Asciidoctor text processor, but if you need more help, check out the AsciiDoc Documentation!

Note	In the raw adoc file, notice the window="_blank" attribute for the link above. This will make it so the link will be opened in a new tab when the user clicks on it. As a shorthand, you can just use an ^ instead! For example, check out the docs

This is a Subtitle

This is a paragraph of regular text.

This is a paragraph with a bold word and an italicized word. Bold italic is also possible.

Words can also have internal bold and italic formatting.

Some constrained monospace text, and some unconstrained monospace text. Let’s keep adding to this line so that it wraps around and then we hit it with some code like this bootstrap.servers and then more stuff

• starts with code and then non code

  • non code and then code and some more
    code

Some Superscript^® text and some subscript text: H₂O.

Code

Java source code with numbered lines:

KafkaStreams streams = new KafkaStreams(builder.build(), config);
streams.start();

Bash command with bash highlighting:

$ cat <<EOF > text.txt \
      hello
      kafka
      my
      old
      friend
EOF

Bash command using bold

$ ./my-cool-script.sh

terminal output from your cool script

Lists

Unordered lists

Unordered list title

• list item 1

  • nested list item

    • nested nested list item 1

    • nested nested list item 2

• list item 2

Ordered lists

Ordered list title

1. ordered list item

   1. nested ordered list item

2. ordered list item

   1. second level list item

      1. third level list item

      2. another third level list item

      3. a final third level list item

   2. another second level list item

Labelled lists

Here’s an example of a labeled list that identifies parts of a computer:

CPU

The brain of the computer.

Hard drive

Permanent storage for operating system and/or user files.

RAM

Temporarily stores information the CPU uses during operation.

Keyboard

Used to enter text or control items on the screen.

Mouse

Used to point to and select items on your computer screen.

Monitor

Displays information in visual form using text and graphics.

A horizontal labelled list

CPU	The brain of the computer.
Hard drive	Permanent storage for operating system and/or user files.
RAM	Temporarily stores information the CPU uses during operation.

Labelled list with bullets

Diary

• Milk

• Eggs

Bakery

• Bread

Produce

• Bananas

Mixed lists

Mixed unordered and ordered lists

1. Linux

   • Fedora

   • Ubuntu

   • Slackware

2. BSD

   • FreeBSD

   • NetBSD

Here’s a list that mixes all three types of lists:

Operating Systems

1. Linux

   • Fedora

   • Ubuntu

   • Slackware

2. BSD

   • FreeBSD

   • NetBSD

Cloud Providers

1. PaaS

   • OpenShift

   • CloudBees

2. IaaS

   • Amazon EC2

   • Rackspace

Tables

Start with ksqlDB when…​ You don’t use Java/Scala You are new to streaming or Kafka You prefer a UI or REST API You can achieve stream processing and state querying use case with KSQL syntax

Start with Kafka Streams when …​ You already use Java/Scala You need tight control over performance You prefer the deployment flexibility of using a Java Library You need custom logic that can’t be described with KSQL syntax

column 1 header	column 2 header
a	b
c	d
Can you do images in a table?

Collapsible Content

hidden secret

You’re awesome.

Admonitions

Tip	This is a tip. There are five admonition labels: Tip, Note, Important, Caution and Warning.

Note	This is a note.

Important

This is important.

Caution

Caution — be careful!

Warning

This is a warning.

Admonition blocks

Note	A "NOTE" type admonition This is an example of an admonition block. Unlike an admonition paragraph, it may contain any AsciiDoc content. The style can be any one of the admonition labels: NOTE TIP WARNING CAUTION IMPORTANT