Admonitions

Page source: https://github.com/riptano/docs-ui/blob/main/preview-src/asciidoc/admonitions.adoc

Basic admonitions

Optional title

An admonition draws the reader’s attention to auxiliary information.

Sign off before stepping away from your computer.

Look for the warp zone under the bridge.

Slippery when wet.

The software you’re about to use is untested.

Examples

Complex admonition

The title of a complex admonition

An admonition block may contain complex content, like lists and tables.

A list

List item
- Nested list item
  - Deeper nested list item
List item
- Another nested list item
List item

A table
Cell in column 1, row 1	Cell in column 2, row 1	Cell in column 1, row 2
Cell in column 2, row 2	Cell in column 1, row 3	Cell in column 2, row 3

A code block

vfs
  .src('js/vendor/*.js', { cwd: 'src', cwdbase: true, read: false })
  .pipe(tap((file) => { (1)
    file.contents = browserify(file.relative, { basedir: 'src', detectGlobals: false }).bundle()
  }))

1	Maybe with a callout.

Another admonition

Admonition styles are set on example blocks, which are delimited by four equal signs (====). When nesting a delimited block that uses the same structural container, it’s necessary to vary the length of the delimiter lines (i.e., make the length of the delimiter lines for the child block different than the length of the delimiter lines for the parent block). Varying the delimiter line length allows the parser to distinguish one block from another.

Admonitions

Basic admonitions

Examples

Complex admonition

Was this helpful?

Give Feedback