Skip to content

Latest commit

 

History

History
178 lines (130 loc) · 2.43 KB

kitchen-sink.adoc

File metadata and controls

178 lines (130 loc) · 2.43 KB

Document Title

Inlines

Here is italic and bold, and and highlighted text. Or span. A word, a sequence of words, or characters are escaped. Don’t use straight quotes, use “quoted” ‘text.’ Mono is foo, but lit mono is like this. Superscript and subscript. <xml> is rad.

Macros

This has a footnote attached to it.[1] Press kbd:[F11] or btn:[OK] to do something.

The text underline me is underlined. The text underline me has custom substitutions. Icon macro: [heart]. Select menu:View[Zoom > Reset] to reset.

cat

This https://google.com is an autolink. And here is an email: jared@netrivet.com. https://google.com brackets are discarded. Longer form macro link is Google. Escaped link: https://google.com.

Listing

fn main() { (1) (2)
    println!("Hello, world!"); // (3)
}
  1. Callout list

    cd /path/to/project

Misc

Lines can have breaks,
Topaz is blue. And so are you. Here is italic and bold, and and highlighted text. Or span.

Title for Paragraph

Howdy!

Discrete Heading

Lists

  • Item 1

  • Item 2

    • Item 2.1

  • Item 3

  • dashes

  • are ok too

    • this is

    • nested

  1. ordered

  2. list

  1. Hand numbered lists

  2. Are harder to maintain

  • ✓ checklists

  • ✓ are easy

  • ❏ to do


foo

bar

baz

qux

lol

this is the definition of lol

Dairy
  • Milk

  • Cheese

Bakery
  • Bread

Continuations

  • The header in AsciiDoc must start with a document title.

    = Document Title

    Keep in mind that the header is optional.

  • Optional author and revision information lines immediately follow the document title.

    = Document Title
    Doc Writer <doc.writer@asciidoc.org>
    v1.0, 2022-01-01

Admonitions

Tip
This is a tip. CAUTION: This is a caution. WARNING: This is a warning. NOTE: This is a note.
Caution
Note
This is a note.

Delimited

Open block

foo & <bar> passthrough

Example block

Listing block

Sidebar block

Ask not what AsciiDoc can do for you


1. This is a footnote.