Use titles to introduce main sections. They structure your documentation and help users navigate content.
#code
## Titles
::
Use subtitles to divide sections further. They create a more detailed content hierarchy for better readability.
#code
### Subtitles
::
Nuxt UI supports most Markdown formatting options.
| Style | How to use | Result |
|---|---|---|
| Bold | **bold** | Bold |
| Italic | *italic* | Italic |
| Strike | ~~strike~~ |
Combine formatting for richer text styles and visual emphasis.
| Style | How to use | Result |
|---|---|---|
| Bold Italic | **_bold italic_** | Bold Italic |
| Bold Strike | ~~**bold**~~ | |
| Italic Strike | ~~*italic*~~ |
For exponents, indices, or mathematical notations, use HTML <sup> and <sub> tags.
| Style | How to use | Result |
|---|---|---|
| Superscript | <sup>superscript</sup> | superscript |
| Subscript | <sub>subscript</sub> | subscript |
Links connect different parts of your documentation and external resources, essential for user navigation and providing references.
To create a link, wrap the link text in brackets []().
#code
[Nuxt UI](https://ui.nuxt.com/getting-started/installation)
::
Organize related items in a structured, readable format. Markdown supports unordered, ordered, and nested lists for various content needs.
Use unordered lists for items without a specific sequence. Start each item with a - symbol.
#code
- I'm a list item.
- I'm another list item.
- I'm the last list item.
::
Use ordered lists when item order matters, like steps in a process. Start each item with a number.
#code
1. I'm a list item.
2. I'm another list item.
3. I'm the last list item.
::
Create hierarchical lists with sub-items for complex structures. Indent sub-items by four spaces for nesting.
#code
- I'm a list item.
- I'm a nested list item.
- I'm another nested list item.
- I'm another list item.
::
Present structured data in rows and columns clearly. Tables are ideal for comparing data or listing properties.
| Prop | Default | Type |
|---|---|---|
name | string | |
size | md | string |
color | neutral | string |
#code
| Prop | Default | Type |
|---------|-----------|--------------------------|
| `name` | | `string`{lang="ts-type"} |
| `size` | `md` | `string`{lang="ts-type"} |
| `color` | `neutral` | `string`{lang="ts-type"} |
::
Highlight important quotations, citations, or emphasized text. Blockquotes visually distinguish quoted content.
Single-line blockquotes are best for short, impactful quotes or citations that fit within a single line. To create a single-line blockquote, add a > in front of a paragraph. Ideal for short and impactful quotes.
Nuxt UI is a collection of Vue components, composables and utils designed to create beautiful and accessible user interfaces.
#code
> Nuxt UI is a collection of Vue components, composables and utils designed to create beautiful and accessible user interfaces.
::
Multi-line blockquotes are suitable for longer quotes or when you need to include multiple paragraphs within a single quotation.
Nuxt UI is a collection of Vue components, composables and utils designed to create beautiful and accessible user interfaces.
Create beautiful, responsive, and accessible Vue applications with Nuxt UI.
#code
> Nuxt UI is a collection of Vue components, composables and utils designed to create beautiful and accessible user interfaces.
>
> Create beautiful, responsive, and accessible Vue applications with Nuxt UI.
::