Skip to content

Commit 4f6f85d

Browse files
docs: document navbar dropdown link type
Co-Authored-By: Catherine Deskur <[email protected]>
1 parent efaf598 commit 4f6f85d

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

fern/products/docs/pages/customization/what-is-docs-yml.mdx

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,10 +242,23 @@ navbar-links:
242242
rounded: false
243243
- type: github
244244
value: https://github.com/example-company/fern
245+
- type: dropdown
246+
text: Resources
247+
icon: fa-solid fa-book
248+
links:
249+
- text: Documentation
250+
href: https://example.com/docs
251+
icon: fa-regular fa-file-lines
252+
- text: API Reference
253+
href: https://example.com/api
254+
icon: fa-regular fa-code
255+
- text: Tutorials
256+
href: https://example.com/tutorials
257+
icon: fa-regular fa-graduation-cap
245258
```
246259

247260
<ParamField path="type" type="enum" required={false} toc={true}>
248-
One of `outlined`, `minimal`, `filled`, or `github`. This value controls the styling of the button.
261+
One of `outlined`, `minimal`, `filled`, `github`, or `dropdown`. This value controls the styling of the button.
249262
</ParamField>
250263

251264
<ParamField path="href" type="string" required={false} toc={true}>
@@ -274,6 +287,15 @@ navbar-links:
274287
By default, the `rightIcon` for a `filled` button is set to `arrow-right`.
275288
</ParamField>
276289

290+
<ParamField path="links" type="list of objects" required={false} toc={true}>
291+
Array of link objects to display in the dropdown menu. This field is used when `type` is set to `dropdown`. Each link object can have the following properties:
292+
- `text` (string): The text to display for the link
293+
- `href` (string): The URL the link points to
294+
- `icon` (string): Optional [Font Awesome icon](https://fontawesome.com/icons) to display to the left of the text
295+
- `rightIcon` (string): Optional [Font Awesome icon](https://fontawesome.com/icons) to display to the right of the text
296+
- `rounded` (boolean): When `true`, the link will have fully rounded borders
297+
</ParamField>
298+
277299
## Footer links configuration
278300

279301
Add clickable social media and community links to your documentation site footer to improve discoverability and engagement.

0 commit comments

Comments
 (0)