mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
4c31f3683c
* ai/ keywords * api/ keywords * components/ keywords * create/ keywords * customize/ keywords * api-playground/ keywords * dashboard/ keywords * deploy/ keywords * guides/ keywords * insights/ keywords * integrations/ keywords * optimize/ keywords * organize/ keywords * root/ keywords * rm temp files
40 lines
1.1 KiB
Plaintext
40 lines
1.1 KiB
Plaintext
---
|
|
title: "Icons"
|
|
description: "Use icons from popular libraries, external URLs, or files in your project."
|
|
keywords: ["Font Awesome", "Lucide", "SVGs"]
|
|
---
|
|
|
|
import IconsRequired from "/snippets/icons-required.mdx";
|
|
|
|
Use icons from Font Awesome, Lucide, SVGs, external URLs, or files in your project to enhance your documentation.
|
|
|
|
<Icon icon="flag" size={32} />
|
|
|
|
```mdx Icon example
|
|
<Icon icon="flag" size={32} />
|
|
```
|
|
|
|
## Inline icons
|
|
|
|
Icons are placed inline when used within a sentence, paragraph, or heading. <Icon icon="flag" iconType="solid" /> Use icons for decoration or to add visual emphasis.
|
|
|
|
```markdown Inline icon example
|
|
Icons are placed inline when used within a sentence, paragraph, or heading. <Icon icon="flag" iconType="solid" /> Use icons for decoration or to add visual emphasis.
|
|
```
|
|
|
|
## Properties
|
|
|
|
<IconsRequired />
|
|
|
|
<ResponseField name="color" type="string">
|
|
The color of the icon as a hex code (for example, `#FF5733`).
|
|
</ResponseField>
|
|
|
|
<ResponseField name="size" type="number">
|
|
The size of the icon in pixels.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="className" type="string">
|
|
Custom CSS class name to apply to the icon.
|
|
</ResponseField>
|