Skip to content

Document navbar dropdown link type #1698

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Nov 2, 2025
Merged

Document navbar dropdown link type #1698

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f6f85d
docs: document navbar dropdown link type
devin-ai-integration[bot] Nov 1, 2025
070cb25
break out options into separate params
devalog Nov 2, 2025
3509bff
formatting nit
devalog Nov 2, 2025
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
39 changes: 38 additions & 1 deletion fern/products/docs/pages/customization/what-is-docs-yml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,10 +242,23 @@ navbar-links:
rounded: false
- type: github
value: https://github.com/example-company/fern
- type: dropdown
text: Resources
icon: fa-solid fa-book
links:
- text: Documentation
href: https://example.com/docs
icon: fa-regular fa-file-lines
- text: API Reference
href: https://example.com/api
icon: fa-regular fa-code
- text: Tutorials
href: https://example.com/tutorials
icon: fa-regular fa-graduation-cap
```

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

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

<ParamField path="links" type="list of objects" required={false} toc={true}>
Items to display in the dropdown menu when `type` is set to `dropdown`.
</ParamField>

<ParamField path="links.text" type="string" required={false} toc={true}>
The text to display for the link.
</ParamField>

<ParamField path="links.href" type="string" required={false} toc={true}>
The URL the link points to.
</ParamField>

<ParamField path="links.icon" type="string" required={false} toc={true}>
[Font Awesome icon](https://fontawesome.com/icons) that displays to the left of the text.
</ParamField>

<ParamField path="links.rightIcon" type="string" required={false} toc={true}>
[Font Awesome icon](https://fontawesome.com/icons) that displays to the right of the text
</ParamField>

<ParamField path="links.rounded" type="boolean" required={false} default={false} toc={true}>
When `true`, the link will have fully rounded borders.
</ParamField>

## Footer links configuration

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