Chuyển đến nội dung
Lou Nguyen
Quay lại blog

Markdown Syntax Checkup

Đăng ngày 3 phút đọcmarkdownmdx

Trong bài này

Lorem ipsum dolor sit amet, consectetur adipiscing elit. This post exercises every piece of Markdown and MDX syntax the blog renders, so the typography, code blocks and components can be checked in one place.

Headings

Lorem ipsum dolor sit amet, consectetur adipiscing elit. The table of contents is built from the H2 and H3 headings of this page.

Heading level 1

Heading level 2

Heading level 3

Heading level 4

Heading level 5
Heading level 6

Paragraphs and line breaks

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.

Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua, after a hard break.

Text styling

Lorem ipsum bold text dolor sit amet, italic text consectetur, bold and italic adipiscing elit, strikethrough sed do eiusmod, and inline code tempor incididunt.

Press Ctrl + K to lorem ipsum. Water is H2O and the area is 10 m2. Lorem ipsum highlighted text dolor sit amet.

Lorem ipsum an inline link dolor sit amet, a reference link consectetur adipiscing elit, and a bare URL https://example.com/bare in the middle of a sentence.

Jump to the code section on this page, or open an external link that opens in a new tab.

Lists

Unordered and ordered lists

  • Lorem ipsum dolor sit amet
  • Consectetur adipiscing elit
  • Sed do eiusmod tempor
  1. Lorem ipsum dolor sit amet
  2. Consectetur adipiscing elit
  3. Sed do eiusmod tempor

Nested and mixed lists

  • Level one lorem
    • Level two ipsum
      • Level three dolor
      • Level three sit
    • Level two amet
  • Level one consectetur
  1. Ordered lorem
    • Unordered ipsum inside ordered
    • Unordered dolor inside ordered
  2. Ordered consectetur
    1. Nested ordered adipiscing
    2. Nested ordered elit

Task list

  • Lorem ipsum dolor sit amet
  • Consectetur adipiscing elit
  • Sed do eiusmod tempor
  • Ut labore et dolore magna aliqua

Blockquotes

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Lorem ipsum dolor sit amet.

Nested quote: consectetur adipiscing elit, sed do eiusmod tempor.

Third level: ut enim ad minim veniam.

A quote with a list and code:

  • Lorem ipsum dolor
  • Sit amet consectetur
const lorem: string = "ipsum";

Code

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Each fenced block below is highlighted for both the light and the dark theme.

Languages

export function add(a: number, b: number): number {
  return a + b;
}
type GreetingProps = { name: string };
 
export function Greeting({ name }: GreetingProps) {
  return <p className="font-medium">Lorem ipsum, {name}</p>;
}
pnpm install
pnpm build --filter lorem
{
  "name": "lorem-ipsum",
  "version": "1.0.0",
  "tags": ["dolor", "sit", "amet"]
}
SELECT id, title
FROM posts
WHERE draft = false
ORDER BY date DESC
LIMIT 10;
- const lorem = "ipsum";
+ const lorem = "dolor";
  const sit = "amet";
Lorem ipsum dolor sit amet
consectetur adipiscing elit

Title, line numbers and highlights

lorem/ipsum.ts
export const dolor = "sit";
export const amet = "consectetur";
const lorem = 1;
const ipsum = 2;
const dolor = 3;
const sit = 4;
const lorem = 1;
const ipsum = 2;
const dolor = 3;
const sit = 4;
const lorem = "ipsum";
const dolor = "ipsum dolor";

A very long line

const loremIpsum = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.";

Tables

Alignment

Left alignedCentre alignedRight aligned
Loremipsumdolor
Sitametconsectetur
NameDescription
loremDolor sit amet, consectetur
ipsumAdipiscing elit, sed do eiusmod

A wide table

Col 1Col 2Col 3Col 4Col 5Col 6Col 7Col 8Col 9
LoremIpsumDolorSitAmetElitSedDoTempor
UtEnimAdMinimQuisNosTrudExUllamco

Horizontal rule

Lorem ipsum dolor sit amet, above the rule.


Consectetur adipiscing elit, below the rule.

Images

A Markdown image:

Lorem ipsum gradient placeholder

An image component with a caption:

Lorem ipsum reversed gradient placeholder
Figure 1. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Footnotes

Lorem ipsum dolor sit amet1, consectetur adipiscing elit, sed do eiusmod tempor2 incididunt ut labore.

HTML in MDX

Lorem ipsum summary

Dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

MDX components

Info callout

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Warning callout

Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Success callout

Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.

Danger callout

Duis aute irure dolor in reprehenderit in voluptate velit esse.

Edge cases

Long unbroken text

Loremipsumdolorsitametconsecteturadipiscingelitseddoeiusmodtemporincididuntutlaboreetdoloremagnaaliquautenimadminimveniamquisnostrudexercitationullamcolaborisnisiutaliquipexeacommodoconsequat

https://example.com/lorem/ipsum/dolor/sit/amet/consectetur/adipiscing/elit/sed/do/eiusmod/tempor/incididunt/ut/labore/et/dolore/magna/aliqua?query=lorem&another=ipsum&yet-another=dolor

Vietnamese diacritics

Tiếng Việt: ă â đ ê ô ơ ư ế ợ ữ

Footnotes

  1. Dolor sit amet, consectetur adipiscing elit, see example.com. ↩

  2. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris. ↩