Skip to content

Commit 4abbfbe

Browse files
committed
update changelog entries
1 parent 20e11da commit 4abbfbe

File tree

2 files changed

+25
-59
lines changed

2 files changed

+25
-59
lines changed
Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,33 @@
11
## Navbar dropdown menus
22

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.
3+
Group related links in your navbar with new dropdown menus. Organize resources, tools, or external links under a single button to keep your header clean.
44

55
```yaml title="docs.yml"
66
navbar-links:
77
- type: dropdown
8-
text: Resources
9-
icon: fa-solid fa-seedling
8+
text: Resources # dropdown button text
9+
icon: fa-solid fa-seedling # optional icon
1010
links:
11-
- text: Plant database
12-
href: https://example.com/plants
13-
icon: fa-regular fa-leaf
11+
- text: Plant database # link display text
12+
href: https://example.com/plants # destination URL
13+
icon: fa-regular fa-leaf # optional icon
1414
- text: Growing guides
1515
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
2016
```
2117
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.
18+
Learn more in the [navbar links configuration documentation](/learn/docs/configuration/what-is-docs-yml#navbar-links-configuration).
3019
3120
## API Explorer direct requests
3221
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.
22+
You can now send API Explorer requests directly to your API instead of through Fern's proxy. This is useful for testing Cross-Origin Resource Sharing (CORS) configuration and debugging authentication flows.
3423
3524
```yaml title="docs.yml"
3625
settings:
3726
disable-explorer-proxy: true
3827
```
3928
4029
<Warning>
41-
When this feature is enabled, your API must have Cross-Origin Resource Sharing (CORS) enabled to allow requests from the documentation domain.
30+
Your API must have CORS enabled to allow requests from the documentation domain.
4231
</Warning>
4332
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.
33+
Learn more in the [docs.yml reference documentation](/learn/docs/configuration/what-is-docs-yml#settingsdisable-explorer-proxy).
Lines changed: 15 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,23 @@
1-
## Custom icons for navbar links and navigation
1+
## Custom icons across your navigation
22

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.
3+
You can now use your own image files as icons throughout your `docs.yml` navigation config, including for [navbar link](/learn/docs/configuration/what-is-docs-yml#navbar-links-configuration), [section, page](/learn/docs/configuration/navigation#sidebar-icons), and [product](/learn/docs/configuration/products#add-your-product-configuration) icons.
44

5-
Icons support three formats:
5+
Icons now support three formats:
66
- **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.
7+
- **Custom image files**: Use relative paths to custom image files (e.g., `./assets/icons/plant-icon.svg`). Paths are relative to the `docs.yml` file.
88
- **Inline SVG**: Provide an SVG string wrapped in quotes.
99

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"
10+
```yaml Sidebar icons in docs.yml
3211
navigation:
33-
- section: Plant care
34-
icon: fa-solid fa-seedling
12+
- section: Home
13+
icon: fa-regular fa-home # Font Awesome icon
3514
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
15+
- page: Introduction
16+
icon: ./assets/icons/intro-icon.svg # Custom image file
17+
path: ./pages/intro.mdx
18+
- page: Custom Features
19+
icon: "<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='currentColor'><path d='M12 2L2 7v10c0 5.55 3.84 10.74 9 12 5.16-1.26 9-6.45 9-12V7l-10-5z'/></svg>" # Inline SVG
20+
path: ./pages/custom.mdx
21+
- api: API Reference
22+
icon: fa-regular fa-puzzle
4223
```
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)