Markdown

This page describes elements and components from MDX that we use and elements that we avoid.

Supported elements / components

We use the following elements.

  • No more than one block per page

Note

note

This is something important the user should be aware of. But no danger.

Tip

tip

Can be used to highlight nice tricks on a very occasional basis.

Caution

caution

Gives a warning about something dangerous.

Table

tabletable
valuevalue
valuevalue

"sql" code block

Title is optional.

title
SELECT * FROM users;

Multi language code block

SELECT * FROM users;

"Script" code block

Use the script language. The title is optional.

some shell command

Elements / components to avoid

Info

info

Not used because hard to differentiate from note

Warning

warning

Warning

Quote

We don't use quotes