diff --git a/components/icons.mdx b/components/icons.mdx index 9afef6ba6..22d041db0 100644 --- a/components/icons.mdx +++ b/components/icons.mdx @@ -1,7 +1,7 @@ --- title: "Icons" description: "Use icons from popular icon libraries" -icon: 'flag' +icon: "flag" --- @@ -11,6 +11,7 @@ icon: 'flag' ```mdx Icon Example ``` + ## Inline Icons @@ -18,15 +19,15 @@ icon: 'flag' The icon will be placed inline when used in a paragraph. ```markdown Inline Icon Example - The documentation you want, effortlessly + The documentation you want, effortlessly. ``` - The documentation you want, effortlessly + The documentation you want, effortlessly. ### Props - 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, URL to an icon, or relative path to an icon. @@ -39,4 +40,4 @@ The icon will be placed inline when used in a paragraph. The size of the icon in pixels - + \ No newline at end of file diff --git a/navigation.mdx b/navigation.mdx index cca3216d4..26c95d5fb 100644 --- a/navigation.mdx +++ b/navigation.mdx @@ -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. -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`. ## Pages @@ -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. + \ No newline at end of file diff --git a/pages.mdx b/pages.mdx index 3bafbb67d..fa53544dd 100644 --- a/pages.mdx +++ b/pages.mdx @@ -1,7 +1,7 @@ --- title: "Pages" description: "Pages are the building blocks of your documentation" -icon: 'letter-text' +icon: "letter-text" --- ## Basics @@ -39,7 +39,7 @@ sidebarTitle: "Short title" ## 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. ```mdx --- @@ -48,9 +48,9 @@ icon: "code" --- ``` -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). -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 --- @@ -116,7 +116,6 @@ Custom Mode provides a minimalist layout by removing all elements except for the 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" @@ -128,7 +127,6 @@ mode: "custom" 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" @@ -172,4 +170,4 @@ content or in search results, but users that search for them will be shown the p --- keywords: ['search', 'indexing'] --- -``` +``` \ No newline at end of file diff --git a/settings.mdx b/settings.mdx index fe236af5b..8645fb08a 100644 --- a/settings.mdx +++ b/settings.mdx @@ -224,12 +224,13 @@ This section contains the full reference for the docs.json file. + The display text for a link. - A valid path or external link + A valid path or external link. - The icon to be displayed in the navbar. + The icon displayed for a link. Can be a URL, Font Awesome icon, or Lucide icon.