You can write content using GitHub-flavored Markdown syntax.

Markdown Syntax

To serve as an example page when styling markdown based Docusaurus sites.

Headers

H1 - Create the best documentation

copy
code withing note

H2 - Create the best documentation

H3 - Create the best documentation

H4 - Create the best documentation

H5 - Create the best documentation

H6 - Create the best documentation

Lists

1. First ordered list item
2. Another item
   • Unordered sub-list.
3. Actual numbers don't matter, just that it's a number
   1. Ordered sub-list
4. And another item.

• Unordered list can use asterisks

• Or minuses

• Or pluses

Links

I'm an inline-style link

I'm an inline-style link with title

I'm a reference-style link

You can use numbers for reference-style link definitions

Or leave it empty and use the link text itself.

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com/ or http://www.example.com/ and sometimes example.com (but not on GitHub, for example).

Some text to show that the reference links can follow later.

Autolink literals

www.example.com, https://example.com, and contact@example.com.

Tasklist

• to do
• done

Images

Here's our logo (hover to see the title text):

Inline-style:

Reference-style:

Images from any folder can be used by providing path to file. Path should be relative to markdown file.

Code

Javascript sample code

copy
var s = "JavaScript syntax highlighting";
alert(s);
function highlightMe() {
  console.log("This line can be highlighted!");
}

YAML sample code

copy
input:
  gcp_pubsub:
    project: foo
    subscription: bar
pipeline:
  processors:
    - bloblang: |
        root.message = this
        root.meta.link_count = this.links.length()
        root.user.age = this.user.age.number()
output:
  redis_streams:
    url: tcp://TODO:6379
    stream: baz
    max_in_flight: 20

Shell sample code

copy
# Install
curl -Lsf https://sh.benthos.dev | bash
# Make a config
benthos create nats/protobuf/aws_sqs > ./config.yaml
# Run
benthos -c ./config.yaml

No syntax sample code

copy
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
This is a link to the other page

Custom CPLN Code with relative links

Tables

Colons can be used to align columns.

There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.

Blockquotes

Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.

Quote break.

This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.

Line Breaks

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.

Admonitions

Details - Summary

Not available yet, will develop a custom component for these cases