Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 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
11 changes: 6 additions & 5 deletions components/icons.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Icons"
description: "Use icons from popular icon libraries"
icon: 'flag'
icon: "flag"
---

<Icon icon="flag" size={32} />
Expand All @@ -11,22 +11,23 @@ icon: 'flag'
```mdx Icon Example
<Icon icon="flag" size={32} />
```

</RequestExample>

## Inline Icons

The icon will be placed inline when used in a paragraph.

```markdown Inline Icon Example
<Icon icon="flag" iconType="solid" /> The documentation you want, effortlessly
<Icon icon="flag" iconType="solid" /> The documentation you want, effortlessly.
```

<Icon icon="flag" iconType="solid" /> The documentation you want, effortlessly
<Icon icon="flag" iconType="solid" /> The documentation you want, effortlessly.

### Props

<ResponseField name="icon" type="string" required>
A [Font Awesome](https://fontawesome.com/icons) or [Lucide](https://lucide.dev/icons) icon
A [Font Awesome](https://fontawesome.com/icons) icon, [Lucide](https://lucide.dev/icons) icon, or URL pointing to an icon.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it also supports images with relative paths

</ResponseField>

<ResponseField name="iconType" type="string">
Expand All @@ -39,4 +40,4 @@ The icon will be placed inline when used in a paragraph.

<ResponseField name="size" type="number">
The size of the icon in pixels
</ResponseField>
</ResponseField>
10 changes: 7 additions & 3 deletions navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The [navigation](settings#param-navigation) property in [docs.json](settings) de
With proper navigation configuration, you can organize your content into a logical hierarchy that makes it easy for users to find exactly what they're looking for.

<Info>
Do not use `api` as a title for any navigation element. The `/api` path is reserved in production and will cause pages to return 404 errors if their URLs contain `/api`.
Do not use `api` as a title for any navigation element. The `/api` path is reserved in production and will cause pages to return 404 errors if their URLs contain `/api`.
</Info>

## Pages
Expand Down Expand Up @@ -45,7 +45,7 @@ Pages is an array where each entry must be a reference to the path of a [page fi

## Groups

Use groups to organize your navigation into sections. Groups can be nested within each other and labeled with tags.
Use groups to organize your navigation into sections. Groups can be nested within each other, labeled with tags, and styled with icons.

<img
className="block dark:hidden pointer-events-none"
Expand All @@ -63,15 +63,18 @@ Use groups to organize your navigation into sections. Groups can be nested withi
"groups": [
{
"group": "Getting Started",
"icon": "play",
"pages": [
"quickstart",
{
"group": "Editing",
"icon": "pencil",
"pages": [
"installation",
"editor",
{
"group": "Nested group",
"icon": "code",
"pages": [
"navigation",
"code"
Expand All @@ -83,6 +86,7 @@ Use groups to organize your navigation into sections. Groups can be nested withi
},
{
"group": "Writing Content",
"icon": "notebook-text",
"tag": "NEW",
"pages": ["writing-content/page", "writing-content/text"]
}
Expand Down Expand Up @@ -516,4 +520,4 @@ This way, you can create a very complex navigation structure that is easy to man
}
```

</CodeGroup>
</CodeGroup>
12 changes: 5 additions & 7 deletions pages.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Pages"
description: "Pages are the building blocks of your documentation"
icon: 'letter-text'
icon: "letter-text"
---

## Basics
Expand Down Expand Up @@ -39,7 +39,7 @@

## Icons

You can set an icon for your sidebar item like the one for this page. You can set icons by using the `icon` metadata.
Add an icon next to your page's sidebar title by including the `icon` field in your page's frontmatter.

Check warning on line 42 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

pages.mdx#L42

Did you really mean 'frontmatter'?

```mdx
---
Expand All @@ -48,9 +48,9 @@
---
```

You can set icons from [Font Awesome](https://fontawesome.com/icons) and [Lucide](https://lucide.dev/icons), depending on the [icon library setting](settings#param-icons).
You can set icons from a URL, [Font Awesome](https://fontawesome.com/icons), or [Lucide](https://lucide.dev/icons). Choose your preferred icon library (Font Awesome or Lucide) with the [icon library setting](settings#param-icons).

Check warning on line 51 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

pages.mdx#L51

Did you really mean 'Lucide'?

You can also set the icon type for Font Awesome icons (optional). If not set, the icon type will be regular.
For Font Awesome icons, you can optionally set the icon type. If not set, the icon type will be regular.

```mdx
---
Expand Down Expand Up @@ -116,7 +116,6 @@
This mode offers a blank canvas, which is ideal for creating a "landing page" or any page where
you want a clean, distraction-free environment.


```mdx
---
mode: "custom"
Expand All @@ -128,7 +127,6 @@
Center Mode removes the sidebar and the table of contents, and centers the page content. This mode is great for changelogs
or any page where you want to focus on the content.


```mdx
---
mode: "center"
Expand Down Expand Up @@ -164,7 +162,7 @@

## Internal Search Optimization

You can also enhance a specific page's discoverability in the built-in search by

Check warning on line 165 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

pages.mdx#L165

Did you really mean 'discoverability'?
providing `keywords` in your metadata. These keywords won't appear as part of the page
content or in search results, but users that search for them will be shown the page as a result.

Expand All @@ -172,4 +170,4 @@
---
keywords: ['search', 'indexing']
---
```
```
5 changes: 3 additions & 2 deletions settings.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.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.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.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.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.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L127

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

Expand Down Expand Up @@ -216,20 +216,21 @@
### Structure

<ResponseField name="navbar" type="object">
Navbar content and settings

Check warning on line 219 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L219

Did you really mean 'Navbar'?

<Expandable title="Navbar">
<ResponseField name="links" type="array of object">
The links in the navbar

Check warning on line 223 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L223

Did you really mean 'navbar'?

<Expandable title="Links">
<ResponseField name="label" type="string" required>
The display text for a link.
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
A valid path or external link
A valid path or external link.
</ResponseField>
<ResponseField name="icon" type="string | object">
The icon to be displayed in the navbar.
The icon displayed for a link. Can be a URL, Font Awesome icon, or Lucide icon.
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -499,7 +500,7 @@

<Expandable title="Api">
<ResponseField name="openapi" type="string or array or object">
A string or an array of strings of absolute or relative urls pointing to the OpenAPI file(s)

Check warning on line 503 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L503

Did you really mean 'urls'?

<Expandable title="Openapi">
<ResponseField name="source" type="string">
Expand Down
Loading