Cursor Code Editor

Headings

Use headings to introduce the main sections. They structure your documentation and help users navigate the content.

## Headings

Subheadings

Use subheadings to break sections down further. They create a more granular content hierarchy for better readability.

### Subheadings

Text Formatting

Nuxt UI supports most Markdown formatting options.

Combine formatting for richer text styles and visual emphasis.

For superscripts, subscripts, or math symbols, use HTML <sup> and <sub> tags.

Links

Links connect sections of your documentation and external resources, essential for user navigation and providing references. To create a link, wrap the link text in brackets []().

[Ahur Platform](https://ahur.ir/docs)

Internal Links

To link within your documentation, use root-relative paths such as /docs/installation.

[Installation](/en/docs/installation)

Lists

Organize related items in a structured, readable format. Markdown supports unordered, ordered, and nested lists for different content needs.

Unordered

Use unordered lists for items without a particular sequence. Start each item with a - symbol.

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

Ordered

Use ordered lists when item order matters, such as steps in a process. Start each item with a number.

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

Nested

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

- 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 ideal for comparing data or listing features.

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

Blockquotes

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

Single-line

Single-line blockquotes are ideal for short, impactful quotes or citations that fit on one line. To create a single-line blockquote, add a > before the paragraph. Ideal for short, impactful quotes.

> The Ahur AI platform is a collection of Vue components, utility functions, and tools designed to create beautiful, accessible user interfaces.

Multi-line

Multi-line blockquotes are suitable for longer quotes or when you need to include multiple paragraphs in a single quote.

> The Ahur AI platform is a collection of Vue components, utility functions, and tools designed to create beautiful, accessible user interfaces.
>
> Build beautiful, responsive, and accessible Vue apps with Ahur AI.

Code

Display code samples and programming snippets with proper formatting.

Inline Code

To display short code within text, use backticks:

To install use `npm install @nuxt/ui`.

Code Blocks

To display larger code blocks:

export default defineNuxtConfig({
  modules: ['@nuxt/ui'],
  ui: {
    primary: 'blue'
  }
})

export default defineNuxtConfig({
  modules: ['@nuxt/ui'],
  ui: {
    primary: 'blue'
  }
})

Code with Highlighting

To display code with syntax highlighting:

<template>
  <div>
    <h1>Hello World!</h1>
  </div>
</template>

<template>
  <div>
    <h1>Hello World!</h1>
  </div>
</template>

Images

To display images in documentation:

![Ahur Logo](https://ahur.ir/logo.png)

Alerts and Tips

To display important alerts and tips:

Buttons and Interactive Links

To display buttons and interactive links: