Markdown

A section header

A beta section BETA

The <Beta /> tag can be used inline BETA and should be applied self-closing

Paragraphs

Paragraphs are separated by a blank line.

Second paragraph. Italic, bold, italic bold, strikethrough, and inline code.

Line Break

The backslash, \, is interpreted as a new line.
This sentence should appear on a new line.

List items

Blockquotes

Block quotes are written like so.

They can span multiple paragraphs, if you like.

Blockquotes can be nested (that is a blockquote-in-a-blockquote) by adding additional levels of >:

This is the first level of quoting.

This is nested blockquote.

Back to the first level.

Blockquotes can contain other Markdown elements, including headers, lists, and code blocks:

Subsection (first level)

Lists

Here's a numbered list:

1. first item
2. second item
3. third item

Here's a nested ordered list:

1. Step 1
   1. Sub-step 1
   2. Sub-step 2
      1. Sub Sub-step 1
      2. Sub Sub-step 2
2. Step 2

Here's a definition list:

Healthy

The subscription is delivering messages as expected

ConfigurationError

Messages can not be delivered with the current configuration. If the configuration is fixed in this health status, all messages that haven’t been delivered yet will still be delivered and the status will change to Healthy.

ConfigurationErrors are automatically turned into ConfigurationErrorDeliveryStopped after some time. See the Delivery Guarantees section for more details.

ConfigurationErrorDeliveryStopped

Messages can not be delivered with the current configuration and delivery of those is not attempted anymore. Undelivered messages are not retained and will not be delivered if the configuration is fixed in this status, but the status will change to Healthy as soon as new messages can be delivered successfully again.

Something else

Yet something else

Subsection (second level)

Now a nested list:

1. First, get these ingredients:

   • carrots
   • celery
   • lentils

2. Boil some water.

3. Dump everything in the pot and follow this algorithm:

   find wooden spoon
   uncover pot
   stir
   cover pot
   balance wooden spoon precariously on pot handle
   wait 10 minutes
   goto first step (or shut off burner when done)

   Do not bump wooden spoon or it falls.

Notice again how text always lines up on 4-space indents (including that last line which continues item 3).

Code blocks

Note again how the actual text starts at 4 columns in (4 characters from the left side). Here's a code sample:

# Let me re-iterate ...
for i in 1 .. 10 { do-something(i) }

As you probably guessed, indented 4 spaces. By the way, instead of indenting the block, you can use delimited blocks, where you can specify syntax highlight (highly recommended):

const sum = (a, b) => a + b;
console.log(sum(5, 2));

Empty code blocks also work without breaking the build:

Links

Here's a link to a website, to a local doc, and to a section heading in the current doc. Here's a footnote ¹.

Tables

Tables look like this:

Horizontal rules

Horizontal rules are not styled.

Constants

• Number and text example -> 64 megabytes
• Number example in bold -> 256
• Text example -> [a-zA-Z0-9_\-]{2,256}
• Long formatted number example -> 1 000 000.999999

String literals

String literals have a customized font style for disambiguations and digits.

• ABCDEFGHIJKLMNOPQRSTUVWXYZ vs ABCDEFGHIJKLMNOPQRSTUVWXYZ
• 0123456789 vs 0123456789
• capital I and small l = IlIlIl vs capital I and small l = IlIlIl

Last section

This section is only useful as an anchor link target.