Skip to content

AsciiDoc kitchen sink

This is a demonstration of Asciidoctor. And this is the preamble of this document.

Purpose

This document exercises many of the features of AsciiDoc to test the Asciidoctor implementation.

A link to anchors and other page.

This is an included snippet.

Setting up a mirror registry for your disconnected Kubernetes environment

In the title of concept modules, include nouns or noun phrases that are used in the body text. This helps readers and search engines find the information quickly. Do not start the title of concept modules with a verb.

Hi.

Some text! Yes some text. Some more text.

This is the other-section xref.

This is some YAML:

apiVersion: operator.openshift.io/v1alpha1
kind: ImageContentSourcePolicy
metadata:
  name: mirror-ocp
spec:
  repositoryDigestMirrors:
  - mirrors:
    - mirror.registry.com:443/ocp/release
    source: quay.io/openshift-release-dev/ocp-release
  - mirrors:
    - mirror.registry.com:443/ocp/release
    source: quay.io/openshift-release-dev/ocp-v4.0-art-dev
$ some code -f

Note

This is a note

Important

This is important!

Caution

Be careful

Tip

This is a tip!

$ echo "code in a tip"
A definition list

Something something something something something.

And then a table:

Table 1. Table title
Firefox Web Browser Software

Ruby

Programming Language

Language

TorqueBox

Application Server

Application
Figure 1. A cat
A cat

This is a symlink test.

$ test

Some text. Some more text.

This is an an xref!

A procedure

Do something.

Prerequisites

  • You have installed the OpenShift CLI (oc).

  • You have logged in as a user with cluster-admin privileges.

Procedure

  1. Unwrap the thing.

  2. Build the thing.

    $ build thing
    Example output
    succeeded!

  3. Release the thing.

Verification

Verify the thing by looking at it.

First Steps with AsciiDoc

Inline markup

  • single quotes around a phrase place 'emphasis'

  • astericks around a phrase make the text bold

  • double astericks around one or more letters in a word make those letters bold

  • double underscore around a substring in a word emphasize that substring

  • use carrots around characters to make them superscript

  • use tildes around characters to make them subscript

  • to pass through HTML directly, surround the text with triple plus

  • characters can be escaped using a \

    • for instance, you can escape a quote inside emphasized text like 'Here's Johnny!'

  • you can safely use reserved XML characters like <, > and &, which are escaped when rendering

  • force a space between inline elements using the {sp} attribute

  • hold text together with an intrinsic non-breaking space attribute, {nbsp}

  • handle words with unicode characters like in the name Gregory Romé

  • claim your copyright ©, registered trademark ® or trademark ™

You can write text with inline links, optionally using an explicit link prefix. In either case, the link can have a query string.

If you want to break a line
just end it in a + sign
and continue typing on the next line.

Anchors

Ahoy!

Lists Upon Lists

Adjacent lists

  • this list

  • should join

  • to have

  • four items

Numbered lists

  1. These items

  2. will be auto-numbered

    1. and can be nested

  3. A numbered list can nest

    • unordered

    • list

    • items

Statement

I swear I left it in 'Guy's' car. Let's go look for it.

term

definition line two

another term

another definition, which can be literal (indented) or regular paragraph

This should be a standalone paragraph, not grabbed by the definition list.

  • first level written on two lines

  • first level

    with this literal text

    • second level

      • third level

        • fourth level

  • back to
    first level

Let’s make a horizontal rule…​

then take a break.

We’re back!

Do you feel safer with the tiger in a box?

Figure 2. Tiger in a box
Tiger
Asciidoctor usage example, should contain 3 lines
doc = Asciidoctor::Document.new("*This* is it!", :header_footer => false)

puts doc.render

Here’s what it outputs (using the built-in templates):

<div class="paragraph">
  <p><strong>This</strong> is it!</p>
</div>

Quotes

AsciiDoc is 'so' powerful!

This verse comes to mind.

La la la

Here’s another quote:

When you have eliminated all which is impossible, then whatever remains, however improbable, must be the truth.

— Sir Arthur Conan Doyle
The Adventures of Sherlock Holmes

Getting Literal

Want to get literal? Just prefix a line with a space (just one will do).
I'll join that party, too.

We forgot to mention in Numbered lists that you can change the numbering style.

  1. first item (yeah!)

  2. second item, looking so mono

  3. third item, mono it is!

Wrap-up

Note

AsciiDoc is quite cool, you should try it!

Info

Go to this URL to learn more about it:

Or you could return to the First Steps or Purpose.

Here’s a reference to the definition of another term, in case you forgot it.

Note

One more thing. Happy documenting!

When all else fails, head over to http://google.com.