Text Formatting

What is Markdown?

TroopBook supports Markdown, a simple way to format text without complicated menus or buttons. Think of it like using shortcuts in a text message—adding asterisks for emphasis or dashes for bullet points—but with a few more options.

Why Markdown? It's:

• Easy to learn: Most formatting uses symbols you already know (like * or #)
• Fast to use: Type naturally without reaching for your mouse
• Widely supported: Works across many platforms and applications
• Plain text: Your content is readable even without formatting

Don't worry if you're new to this! You don't need to memorize everything. Start with the basics below and refer back to this guide as needed. Most people only use a handful of these features regularly.

Titles

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

## Titles

Subtitles

Use subtitles to divide sections further. They create a more detailed content hierarchy for better readability.

### Subtitles

Text Formatting

Nuxt UI supports most Markdown formatting options.

Combine formatting for richer text styles and visual emphasis.

For exponents, indices, or mathematical notations, use HTML <sup> and <sub> tags.

Links

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 []().

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

Internal links

For linking within your documentation, use root-relative paths like /getting-started/installation.

[Installation](/getting-started/installation)

Lists

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

Unordered

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

- I'm a list item.
- I'm another list item.
- I'm the last list item.

Ordered

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

1. I'm a list item.
2. I'm another list item.
3. I'm the last list item.

Nested

Create hierarchical lists with sub-items for complex structures. Indent sub-items by four spaces for nesting.

- I'm a list item.
  - I'm a nested list item.
  - I'm another nested list item.
- I'm another list item.

Tables

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

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

Blockquotes

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

Singleline

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.

Multiline

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.