VitePress

Markdown VitePress reference

Frontmatter (todo)

Frontmatter

Syntax Highlighting in Code Blocks

VitePress uses Shiki for syntax highlighting.

A list of valid languages is available on Shiki's repository.

Some of the most important languages are:

LANGUAGES

• js for JavaScript
• ts for TypeScript
• asm for Assembly
• cpp for C++
• c for C
• json for JSON
• json5 for JSON5
• latex for LaTeX
• md for Markdown
• log for Log files
• python for Python
• prisma for Prisma
• riscv for RISC-V
• zsh for Z Shell
• sql for SQL
• tsx for TypeScript JSX

Code Blocks (TODO)

WARNING

TODO: More code block examples

VitePress Markdown

Info box

INFO

This is an info box.

::: info
This is an info box.
:::

Tip

TIP

This is a tip.

::: tip
This is a tip.
:::

Warning

WARNING

This is a warning.

::: warning
This is a warning.
:::

Danger

DANGER

This is a dangerous warning.

::: danger
This is a dangerous warning.
:::

Details

Details

This is a details block.

::: details
This is a details block.
:::

Custom Title

STOP

Danger zone, do not proceed!

::: danger STOP
Danger zone, do not proceed!
:::

Nested details with a warning and a code block

Details

This is a details block.

DANGER

This is a dangerous warning.

console.log('Hello, world!')

GitHub-flavored Alerts

Note

> [!NOTE]
> This is a note.
> ```js
> console.log('Hello, world!')
> ```

NOTE

This is a note.

console.log('Hello, world!')

Tip

> [!TIP]
> This is a tip.
> ```js
> console.log('Hello, world!')
> ```

TIP

This is a tip.

console.log('Hello, world!')

Important

> [!IMPORTANT]
> This is important.
> ```js
> console.log('Hello, world!')
> ```

IMPORTANT

This is important.

console.log('Hello, world!')

Warning

> [!WARNING]
> This is a warning.
> ```js
> console.log('Hello, world!')
> ```

WARNING

This is a warning.

console.log('Hello, world!')

Caution

> [!CAUTION]
> This is a caution.
> ```js
> console.log('Hello, world!')
> ```

CAUTION

This is a caution.

console.log('Hello, world!')

Math Equations

When , there are two solutions to and they are

Maxwell's equations:

equation	description
	divergence of is zero
	curl of is proportional to the rate of change of
	wha?

Row Vector 1x3

To write a row vector, use the following syntax:

Column Vector 3x1

To write a column vector, use the following syntax:

Matrix 3x3

To write a matrix, use the following syntax:

this