Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include Lucide in icon options #566

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/components/accordions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ icon: "square-caret-down"
</ResponseField>

<ResponseField name="icon" type="string or svg">
A [Font Awesome icon](https://fontawesome.com/icons) or SVG code
A [Font Awesome icon](https://fontawesome.com/icons), [Lucide icon](https://lucide.dev/icons), or SVG code
</ResponseField>

<ResponseField name="iconType" type="string">
Expand Down
2 changes: 1 addition & 1 deletion content/components/cards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Add an `img` property to a card to display an image on the top of the card.
</ResponseField>

<ResponseField name="icon" type="string or svg">
A [Font Awesome icon](https://fontawesome.com/icons) or SVG code in `icon={}`
A [Font Awesome icon](https://fontawesome.com/icons), [Lucide icon](https://lucide.dev/icons), or SVG code in `icon={}`
</ResponseField>

<ResponseField name="iconType" type="string">
Expand Down
2 changes: 1 addition & 1 deletion content/components/icons.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Icons"
description: "Use [Font Awesome](https://fontawesome.com/icons) icons anywhere in the doc"
description: "Use [Font Awesome](https://fontawesome.com/icons) or [Lucide](https://lucide.dev/icons) icons anywhere in the doc"
icon: "icons"
---

Expand Down
2 changes: 1 addition & 1 deletion content/components/steps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Steps are the best way to display a series of actions of events to your users. Y
</ResponseField>

<ResponseField name="icon" type="string or svg">
A [Font Awesome icon](https://fontawesome.com/icons) or SVG code in `icon={}`
A [Font Awesome icon](https://fontawesome.com/icons), [Lucide icon](https://lucide.dev/icons), or SVG code in `icon={}`
</ResponseField>

<ResponseField name="iconType" type="string">
Expand Down
4 changes: 2 additions & 2 deletions navigation/divisions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Anchors are another way to section your content. They show up on top of your sid
</Frame>

The configuration is very similar to the tab configuration. We highly recommend that you set an `icon` field as well.
The icon values are [fontawesome icons](https://fontawesome.com/search)
Valid icon values include all named [Font Awesome](https://fontawesome.com/icons) and [Lucide](https://lucide.dev/icons) icons.

```json docs.json
"navigation": {
Expand Down Expand Up @@ -91,7 +91,7 @@ The icon values are [fontawesome icons](https://fontawesome.com/search)
</Frame>

Dropdowns show up in the same place as anchors, but are consolidated into a single dropdown.
We also recommend that you set an icon for each dropdown item ([options](https://fontawesome.com/search)).
We also recommend that you set an icon for each dropdown item (from [Font Awesome](https://fontawesome.com/icons) or [Lucide](https://lucide.dev/icons)).
```json docs.json
"navigation": {
"dropdowns": [
Expand Down
4 changes: 2 additions & 2 deletions page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ sidebarTitle: "Short title"

Want an icon for your sidebar item like the ones in
[components](/content/components/accordions)? You can set an `icon` attribute in
the metadata! All icons from [Font Awesome](https://fontawesome.com/icons) are
available for us. You can also set an icon type (optional). If not set, the icon
the metadata! All icons from [Font Awesome](https://fontawesome.com/icons) and [Lucide](https://lucide.dev/icons) are
available for us. You can also set an icon type for Font Awesome icons (optional). If not set, the icon
type will be regular.

```md
Expand Down
6 changes: 3 additions & 3 deletions settings/global.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
The eyebrows style of the content. Defaults to `section`.
</ResponseField>
<ResponseField name="codeblocks" type="&quot;system&quot; | &quot;dark&quot;">
The codeblock theme. Defaults to `system`.

Check warning on line 99 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L99

Did you really mean 'codeblock'?
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -115,7 +115,7 @@

<Expandable title="Fonts">
<ResponseField name="family" type="string" required>
The font family, such as "Open Sans", "Playfair Display"

Check warning on line 118 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L118

Did you really mean 'Playfair'?
</ResponseField>
<ResponseField name="weight" type="number">
The font weight, such as 400, 700. Precise font weights such as 550 are supported for variable fonts.
Expand All @@ -124,7 +124,7 @@
The font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2
</ResponseField>
<ResponseField name="format" type="&quot;woff&quot; | &quot;woff2&quot;">
The font format, can be one of woff, woff2

Check warning on line 127 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L127

Did you really mean 'woff'?
</ResponseField>
<ResponseField name="heading" type="object">

Expand Down Expand Up @@ -968,11 +968,11 @@
</ResponseField>

<ResponseField name="icon" type="string">
The [Fontawesome](https://fontawesome.com/icons) icon for the group. Note: this only applies to sub-folders.
The [Font Awesome](https://fontawesome.com/icons) or [Lucide](https://lucide.dev/icons) icon for the group. Note: this only applies to sub-folders.
</ResponseField>

<ResponseField name="iconType" type="string">
The type of [Fontawesome](https://fontawesome.com/icons) icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin
The type of icon (only for [Font Awesome](https://fontawesome.com/icons) icons). Must be one of: brands, duotone, light, sharp-solid, solid, thin
</ResponseField>

</Expandable>
Expand Down Expand Up @@ -1111,7 +1111,7 @@
</ResponseField>

<ResponseField name="icon" type="string">
The [Font Awesome](https://fontawesome.com/search?q=heart) icon used to feature the anchor.
The [Font Awesome](https://fontawesome.com/icons) or [Lucide](https://lucide.dev/icons) icon used to feature the anchor.

Example: `comments`
</ResponseField>
Expand Down Expand Up @@ -1533,14 +1533,14 @@
"pages": ["analytics/posthog"]
}
],
"footerSocials": {

Check warning on line 1536 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L1536

Did you really mean 'footerSocials'?
"github": "https://github.com/mintlify",
"slack": "https://mintlify.com/community",
"x": "https://x.com/mintlify"
},
"integrations": {
"intercom": "APP_ID",
"frontchat": "CHAT_ID"

Check warning on line 1543 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L1543

Did you really mean 'frontchat'?
}
}
```
Expand Down
Loading