Skip to content

Commit 20e11da

Browse files
docs: add changelog entries for recent Docs product features
- Add navbar dropdown menus feature (Nov 2) - Add API Explorer disable-explorer-proxy setting (Nov 2) - Add custom icons for navbar links and navigation (Nov 3) Co-Authored-By: Catherine Deskur <[email protected]>
1 parent b57fe8e commit 20e11da

File tree

2 files changed

+90
-0
lines changed

2 files changed

+90
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## Navbar dropdown menus
2+
3+
Organize multiple related links in your navbar with dropdown menus. This new navbar link type allows you to group resources, tools, or external links under a single dropdown button, keeping your header clean while providing easy access to multiple destinations.
4+
5+
```yaml title="docs.yml"
6+
navbar-links:
7+
- type: dropdown
8+
text: Resources
9+
icon: fa-solid fa-seedling
10+
links:
11+
- text: Plant database
12+
href: https://example.com/plants
13+
icon: fa-regular fa-leaf
14+
- text: Growing guides
15+
href: https://example.com/guides
16+
icon: fa-regular fa-book
17+
- text: Community forum
18+
href: https://example.com/forum
19+
icon: fa-regular fa-comments
20+
```
21+
22+
Each dropdown link supports:
23+
- **text**: The display text for the link
24+
- **href**: The destination URL
25+
- **icon**: Optional Font Awesome icon or custom image that displays to the left of the text
26+
- **rightIcon**: Optional icon that displays to the right of the text
27+
- **rounded**: Optional boolean to apply fully rounded borders
28+
29+
Learn more in the [navbar links configuration](/learn/docs/configuration/what-is-docs-yml#navbar-links-configuration) documentation.
30+
31+
## API Explorer direct requests
32+
33+
Bypass the Fern proxy and send API Explorer requests directly to your API with the new `disable-explorer-proxy` setting. This is useful when you want to test your API's CORS configuration or need direct communication between the documentation site and your API.
34+
35+
```yaml title="docs.yml"
36+
settings:
37+
disable-explorer-proxy: true
38+
```
39+
40+
<Warning>
41+
When this feature is enabled, your API must have Cross-Origin Resource Sharing (CORS) enabled to allow requests from the documentation domain.
42+
</Warning>
43+
44+
By default, API Explorer requests are proxied through Fern's servers to avoid CORS issues. With this setting enabled, requests go directly from the user's browser to your API, which can be helpful for testing CORS policies or debugging authentication flows.
45+
46+
Learn more in the [docs.yml reference](/learn/docs/configuration/what-is-docs-yml#settings-configuration) documentation.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Custom icons for navbar links and navigation
2+
3+
Add visual interest and improve navigation clarity with custom icons throughout your documentation site. You can now add icons to navbar buttons, dropdown menu items, sidebar sections, and pages.
4+
5+
Icons support three formats:
6+
- **Font Awesome icons**: Use icon names like `fa-solid fa-seedling` or `fa-regular fa-leaf`. Pro and Brand icons from Font Awesome are supported.
7+
- **Custom image files**: Use relative paths to image files (e.g., `./assets/icons/plant-icon.svg`). Paths are relative to the `docs.yml` file.
8+
- **Inline SVG**: Provide an SVG string wrapped in quotes.
9+
10+
### Navbar link icons
11+
12+
Add icons to navbar buttons and dropdown menu items:
13+
14+
```yaml title="docs.yml"
15+
navbar-links:
16+
- type: minimal
17+
text: Plant catalog
18+
href: https://example.com/plants
19+
icon: fa-solid fa-seedling
20+
- type: filled
21+
text: Get started
22+
href: https://example.com/start
23+
icon: ./assets/icons/leaf.svg
24+
rightIcon: fa-solid fa-arrow-right
25+
```
26+
27+
### Sidebar navigation icons
28+
29+
Add icons to sections and pages in your sidebar:
30+
31+
```yaml title="docs.yml"
32+
navigation:
33+
- section: Plant care
34+
icon: fa-solid fa-seedling
35+
contents:
36+
- page: Watering guide
37+
icon: fa-solid fa-droplet
38+
path: ./pages/watering.mdx
39+
- page: Sunlight requirements
40+
icon: ./assets/icons/sun.svg
41+
path: ./pages/sunlight.mdx
42+
```
43+
44+
Learn more in the [navigation configuration](/learn/docs/configuration/navigation#sidebar-icons) and [navbar links configuration](/learn/docs/configuration/what-is-docs-yml#navbar-links-configuration) documentation.

0 commit comments

Comments
 (0)