Markdown & MDX Syntax Test
This page is a small rendering checklist. It deliberately includes the syntax I am most likely to use in future notes.
Headings and paragraphs
Heading level one
This is a normal paragraph with a manual line break
and a second line in the same paragraph.
Heading level three
Heading level four
Heading level five
Heading level six
Inline formatting
Here is italic text, bold text, bold italic text, and strikethrough text. You can also use inline code, escaped characters like *this*, and an HTML entity such as ©.
Keyboard shortcuts can use Ctrl + K. The custom link renderer opens an external link in a new tab and keeps an internal link inside the site.
Links and images
Autolink literals should work too: https://example.com and test@example.com.
Image caption: standard Markdown image syntax renders as an ordinary responsive image.
Reference-style links are supported: the project repository.
Bookmark cards and image rows
Only a pure angle-bracket URL becomes a bookmark card:
github.com/Tan35/quiet-notesOpen this link to view the referenced page.github.com/Tan35/quiet-notesThis normal Markdown link stays inline.
Images on one source line share a row; a new line starts the next row:
Blockquotes
Good interfaces make the next step feel obvious.
This is a nested blockquote.
— A tiny design principle
Lists
- Unordered list item
- Another item
- Nested unordered item
- Another nested item
- Ordered list item
- Another ordered item
- Nested ordered item
- Another nested item
Task list
- Render headings and paragraphs
- Render a table
- Add more examples later
Table
| Feature | Syntax | Status |
|---|---|---|
| Emphasis | *text* | Ready |
| Links | [label](url) | Ready |
| Tables | pipes and dashes | Ready |
Code blocks
A TypeScript code block should receive syntax highlighting:
type Theme = 'light' | 'dark'
function nextTheme(theme: Theme): Theme {
return theme === 'dark' ? 'light' : 'dark'
}
A diff block is useful when documenting a change:
- const spacing = 'tight'
+ const spacing = 'comfortable'
Angle-bracket URLs inside code remain code, not bookmark cards:
<https://example.com>
Details and other inline MDX
Click to reveal a native HTML details block
This content is hidden until the summary is opened.
This details block starts open
The open attribute is preserved by MDX.
Footnotes
Footnotes are useful for small asides or sources.1 They stay out of the main paragraph flow.2
The horizontal rule above separates the checklist from this closing note.