Skip to content

Commit 3bb55a7

Browse files
Update from code changes: note emoji as icon option (#7337)
* docs: note emoji as an icon option in frontmatter and components * translations * fix emoji examples for Windows * copy edits --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
1 parent b8c59ce commit 3bb55a7

16 files changed

Lines changed: 21 additions & 9 deletions

‎components/icons.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: "Icons"
3-
description: "Add icons from Font Awesome, Lucide, Tabler, or custom sources to your documentation pages using the icon component with size and color options."
4-
keywords: ["Font Awesome", "Lucide", "Tabler", "SVGs"]
3+
description: "Add icons from Font Awesome, Lucide, Tabler, emoji, or custom sources to your documentation pages using the icon component with size and color options."
4+
keywords: ["Font Awesome", "Lucide", "Tabler", "SVGs", "emoji"]
55
boost: 3
66
---
77

88
import IconsRequired from "/snippets/icons-required.mdx";
99

10-
Use icons from Font Awesome, Lucide, Tabler, SVGs, external URLs, or files in your project to enhance your documentation.
10+
Use icons from Font Awesome, Lucide, Tabler, emoji, SVGs, external URLs, or files in your project to enhance your documentation.
1111

1212
<Icon icon="flag" size={32} />
1313

@@ -38,7 +38,7 @@ Icons appear inline when used within a sentence, paragraph, or heading. <Icon ic
3838
<IconsRequired />
3939

4040
<ResponseField name="color" type="string">
41-
The color of the icon as a hex code (for example, `#FF5733`).
41+
The color of the icon as a hex code (for example, `#FF5733`). Not applied to emoji icons.
4242
</ResponseField>
4343

4444
<ResponseField name="size" type="number">

‎components/tabs.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Set these properties on each individual `<Tab>` component.
103103
</ResponseField>
104104

105105
<ResponseField name="icon" type="string">
106-
A [Font Awesome](https://fontawesome.com/icons) icon, [Lucide](https://lucide.dev/icons) icon, URL to an icon, or relative path to an icon.
106+
A [Font Awesome](https://fontawesome.com/icons), [Lucide](https://lucide.dev/icons), or [Tabler](https://tabler.io/icons) icon, a single emoji, a URL to an icon, or a relative path to an icon.
107107
</ResponseField>
108108

109109
<ResponseField name="iconType" type="string">

‎components/view.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ If you have different heading structures in each view, users only see the headin
6060
</ResponseField>
6161

6262
<ResponseField name="icon" type="string">
63-
A [Font Awesome](https://fontawesome.com/icons) icon, [Lucide](https://lucide.dev/icons) icon, URL to an icon, or relative path to an icon.
63+
A [Font Awesome](https://fontawesome.com/icons), [Lucide](https://lucide.dev/icons), or [Tabler](https://tabler.io/icons) icon, a single emoji, a URL to an icon, or a relative path to an icon.
6464
</ResponseField>
6565

6666
<ResponseField name="iconType" type="string">

‎es/organize/pages.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Usa el frontmatter para controlar:
4545
* nombre del [icono de Font Awesome](https://fontawesome.com/icons)
4646
* nombre del [icono de Lucide](https://lucide.dev/icons)
4747
* nombre del [icono de Tabler](https://tabler.io/icons)
48+
* Un solo emoji (por ejemplo, `💡` o `🚀`)
4849
* URL de un icono alojado externamente
4950
* Ruta a un archivo de icono en tu proyecto
5051
</ResponseField>

‎fr/organize/pages.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Utilisez le frontmatter pour contrôler :
4545
* Nom de l’[icône Font Awesome](https://fontawesome.com/icons)
4646
* Nom de l’[icône Lucide](https://lucide.dev/icons)
4747
* Nom de l’[icône Tabler](https://tabler.io/icons)
48+
* Un seul emoji (par exemple, `💡` ou `🚀`)
4849
* URL d’une icône hébergée en externe
4950
* Chemin vers un fichier d’icône dans votre projet
5051
</ResponseField>

‎organize/pages.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Use frontmatter to control:
4242
- [Font Awesome icon](https://fontawesome.com/icons) name
4343
- [Lucide icon](https://lucide.dev/icons) name
4444
- [Tabler icon](https://tabler.io/icons) name
45+
- A single emoji (for example, `💡` or `🚀`)
4546
- URL to an externally hosted icon
4647
- Path to an icon file in your project
4748
</ResponseField>

‎organize/settings-reference.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ Links displayed in the navbar.
549549
| `type` | `"github"` \| `"discord"` | No | Link type. Omit for a standard link. |
550550
| `label` | string | Conditional | Required when `type` is omitted. |
551551
| `href` | string (uri) | Yes | Link destination. |
552-
| `icon` | string | No | Icon name, URL, path, or SVG. |
552+
| `icon` | string | No | Icon name, emoji, URL, path, or SVG. |
553553
| `iconType` | string | No | Font Awesome icon style only. |
554554

555555
#### `navbar.primary`
@@ -657,7 +657,7 @@ Custom option object fields:
657657
|---|---|---|---|
658658
| `title` | string | Yes | Display title. |
659659
| `description` | string | Yes | Description text. |
660-
| `icon` | string | No | Icon name, URL, path, or SVG. |
660+
| `icon` | string | No | Icon name, emoji, URL, path, or SVG. |
661661
| `href` | string or object | Yes | Link destination. Supports `$page`, `$path`, `$mcp` placeholders. |
662662

663663
#### `contextual.display`

‎snippets/es/icons-optional.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* Nombre del ícono de [Font Awesome](https://fontawesome.com/icons), si tienes la [propiedad](/es/organize/settings#param-icons) `icons.library` configurada como `fontawesome` en tu `docs.json`
77
* Nombre del ícono de [Lucide](https://lucide.dev/icons), si tienes la [propiedad](/es/organize/settings#param-icons) `icons.library` configurada como `lucide` en tu `docs.json`
88
* Nombre del ícono de [Tabler](https://tabler.io/icons), si tienes la [propiedad](/es/organize/settings#param-icons) `icons.library` configurada como `tabler` en tu `docs.json`
9+
* Un solo emoji (por ejemplo, `💡` o `🚀`)
910
* URL de un ícono alojado externamente
1011
* Ruta a un archivo de ícono en tu proyecto
1112
* Código SVG envuelto entre llaves

‎snippets/es/icons-required.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* [Font Awesome icon](https://fontawesome.com/icons) name, if you have the `icons.library` [property](/es/organize/settings#param-icons) set to `fontawesome` in your `docs.json`
1111
* [Lucide icon](https://lucide.dev/icons) name, if you have the `icons.library` [property](/es/organize/settings#param-icons) set to `lucide` in your `docs.json`
1212
* Nombre del [icono Tabler](https://tabler.io/icons), si tienes la `icons.library` [propiedad](/es/organize/settings#param-icons) configurada como `tabler` en tu `docs.json`
13+
* Un solo emoji (por ejemplo, `💡` o `🚀`)
1314
</ResponseField>
1415

1516
<ResponseField name="src" type="string">

‎snippets/fr/icons-optional.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* [Font Awesome](https://fontawesome.com/icons) nom d’icône, si vous avez la propriété `icons.library` [paramètres](/fr/organize/settings#param-icons) définie sur `fontawesome` dans votre `docs.json`
77
* [Lucide](https://lucide.dev/icons) nom d’icône, si vous avez la propriété `icons.library` [paramètres](/fr/organize/settings#param-icons) définie sur `lucide` dans votre `docs.json`
88
* [Tabler](https://tabler.io/icons) nom d’icône, si vous avez la propriété `icons.library` [paramètres](/fr/organize/settings#param-icons) définie sur `tabler` dans votre `docs.json`
9+
* Un seul emoji (par exemple, `💡` ou `🚀`)
910
* URL vers une icône hébergée en externe
1011
* Chemin vers un fichier d’icône dans votre projet
1112
* Code SVG entouré d’accolades

0 commit comments

Comments
 (0)