Elements
Heading example
Here is an example of headings. You can use this heading by the following markdown rules. For example: use # for heading 1 and use ###### for heading 6.
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Admonition
This is my own component which is auto-imported in all mdx files. You can use it like:
<Admonition variant="info">Your text here</Admonition>
TIP
Admonition variant="tip". Use this to provide a cool tip.
CAUTION
Admonition variant="caution". Use this to warn people of potential issues.
DANGER
Admonition variant="danger". Use this to tell people not to do something.
INFO
Admonition variant="info". Use this to provide extra secret sauce.
Emphasis
The emphasis, aka italics, with asterisks or underscores.
Strong emphasis, aka bold, with asterisks or underscores.
The combined emphasis with asterisks and ***underscores***.
Strikethrough uses two tildes. Scratch this.
Link
I’m an inline-style link with title
You can use numbers for reference-style link definitions
Or leave it empty and use the link text itself.
example.com (but not on Github, for example).
Some text to show that the reference links can follow later.
Paragraph
Lorem ipsum dolor sit amet consectetur adipisicing elit. Quam nihil enim maxime corporis cumque totam aliquid nam sint inventore optio modi neque laborum officiis necessitatibus, facilis placeat pariatur! Voluptatem, sed harum pariatur adipisci voluptates voluptatum cumque, porro sint minima similique magni perferendis fuga! Optio vel ipsum excepturi tempore reiciendis id quidem? Vel in, doloribus debitis nesciunt fugit sequi magnam accusantium modi neque quis, vitae velit, pariatur harum autem a! Velit impedit atque maiores animi possimus asperiores natus repellendus excepturi sint architecto eligendi non, omnis nihil. Facilis, doloremque illum. Fugit optio laborum minus debitis natus illo perspiciatis corporis voluptatum rerum laboriosam.
Ordered List
-
List item
-
List item
-
List item
-
List item
-
List item
Unordered List
-
List item
-
List item
-
List item
-
List item
-
List item
Code and Syntax Highlighting
This is an Inline code sample.
var s = "JavaScript syntax highlighting";
alert(s);
s = "Python syntax highlighting"
print s
Blockquote
This is a blockquote example.
Tables
| Markdown | Less | Pretty |
|---|---|---|
| Still | renders | nicely |
| 1 | 2 | 3 |
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.