---
title: "Markdown Syntax"
description: "Master standard Markdown syntax for text formatting in Movk Nuxt Docs, including heading levels, bold/italic, ordered and unordered lists, inline code, hyperlinks, and images, to build clear, well-structured technical documentation."
canonical_url: "https://docs.mhaibaraai.cn/en/docs/typography/markdown-syntax"
---
# Markdown Syntax

> Master standard Markdown syntax for text formatting in Movk Nuxt Docs, including heading levels, bold/italic, ordered and unordered lists, inline code, hyperlinks, and images, to build clear, well-structured technical documentation.

## Headings

Use headings to organize the main sections of a document, which helps users navigate and understand the content better.

```mdc
## Heading
```

### Subheading

Use subheadings to further break down content, creating a clearer hierarchy and improving readability.

```mdc
### Subheading
```

> [!TIP]
> 
> Every heading and subheading automatically generates an anchor and appears in the page's table of contents.

## Text formatting

Movk Nuxt Docs supports most standard Markdown text formatting options.

| Style | Syntax | Result |
| --- | --- | --- |
| Bold | `**Bold**` | **Bold** |
| Italic | `*Italic*` | *Italic* |
| Strikethrough | `~~Strikethrough~~` | ~~Strikethrough~~ |

You can combine these formats for richer text styles and visual emphasis.

| Style | Syntax | Result |
| --- | --- | --- |
| Bold italic | `***Bold italic***` | ***Bold italic*** |
| Bold strikethrough | `~~**Bold**~~` | ~~**Bold**~~ |
| Italic strikethrough | `~~*Italic*~~` | ~~*Italic*~~ |

## Links

Links connect different parts of your documentation or point to external resources, and are essential for user navigation and for providing references. To create a link, wrap the link text in square brackets `[]`, followed by the URL in parentheses `()`.

```mdc
[Nuxt UI](https://ui.nuxt.com/getting-started/installation/nuxt)
```

### Internal links

To create a link within the documentation, use a path relative to the root, such as `/docs/getting-started/installation`.

```mdc
[Installation](/en/docs/getting-started/installation)
```

## Lists

Lists organize related items in a structured, easy-to-read format. Markdown supports unordered lists, ordered lists, and nested lists to meet different content needs.

### Unordered lists

For items in no particular order, use an unordered list. Each list item starts with a `-` symbol.

```mdc
- I am a list item.
- I am another list item.
- I am the last list item.
```

### Ordered lists

Use an ordered list when the order of items matters, such as steps in a process. Each item starts with a number.

```mdc
1. I am a list item.
2. I am another list item.
3. I am the last list item.
```

### Nested lists

Create hierarchical lists with sub-items for complex structures. Indent sub-items by four spaces to nest them.

```mdc
- I am a list item.
  - I am a nested list item.
  - I am another nested list item.
- I am another list item.
```

## Tables

Present structured data clearly in rows and columns. Tables are great for comparing data or listing properties.

```mdc
| Prop    | Default   | Type                     |
|---------|-----------|--------------------------|
| `name`  |           | `string`{lang="ts-type"} |
| `size`  | `md`      | `string`{lang="ts-type"} |
| `color` | `neutral` | `string`{lang="ts-type"} |
```

## Blockquotes

Highlight important quotes, references, or emphasized text. Blockquotes visually distinguish quoted content.

### Single line

A single-line blockquote works best for short, punchy quotes or quotes that fit on a single line. To create a single-line blockquote, add `>` before the paragraph. Great for short, punchy quotes.

```mdc
> Nuxt UI is a collection of Vue components, composables, and utilities built on top of Reka UI, focused on structure and layout, and designed to be the building blocks of your application.
```

### Multi-line

A multi-line blockquote works for longer quotes or when you need to include multiple paragraphs in a single quote.

```mdc
> Nuxt UI is a collection of Vue components, composables, and utilities built on top of Reka UI, focused on structure and layout, and designed to be the building blocks of your application.
>
> Use Nuxt UI to build beautiful, responsive, and accessible Vue applications.
```


## Sitemap

See the full [sitemap](https://docs.mhaibaraai.cn/sitemap.md) for all pages.