You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can now configure products to link to external URLs (separate applications, third-party documentation, or other external resources) instead of documentation within your site.
4
+
5
+
External products appear in the product switcher alongside internal products but navigate users to the specified URL when selected. Unlike internal products, external products are defined directly in `docs.yml` using `href`—no standalone product `.yml` file is needed.
6
+
7
+
To define an external product, add an item to the `products` list in `docs.yml` with an `href` instead of a `path`:
8
+
9
+
```yaml title="docs.yml"
10
+
products:
11
+
- display-name: API Documentation
12
+
path: ./products/api-docs.yml
13
+
icon: fa-solid fa-book
14
+
slug: api-docs
15
+
subtitle: Complete API reference
16
+
17
+
- display-name: Dashboard # External product
18
+
href: https://dashboard.example.com
19
+
icon: fa-solid fa-chart-line
20
+
subtitle: Analytics and insights
21
+
```
22
+
23
+
Visit the [product switching documentation](/learn/docs/configuration/products#define-your-products) to learn more.
Copy file name to clipboardExpand all lines: fern/products/docs/pages/navigation/products.mdx
+42-27Lines changed: 42 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,8 @@ subtitle: Allow users to seamlessly navigate between different products you offe
26
26
27
27
Each product can contain its own distinct versions, tabs, sections, pages, and API references. Products can share content as well.
28
28
29
+
Products can be internal (hosted on your site) or external (linking to external URLs).
30
+
29
31
## Add products to your docs
30
32
31
33
<Stepstoc={true}>
@@ -34,6 +36,10 @@ Each product can contain its own distinct versions, tabs, sections, pages, and A
34
36
Create a `products` folder inside of your `fern` folder. To specify a product's contents and navigational structure, add a `.yml` file to the `products` folder for each product.
35
37
Make sure to include the `navigation` and `tabs` properties, if applicable.
36
38
39
+
<Infotitle="External products">
40
+
You can also define external products, which link to external URLs (separate applications, third-party documentation, or other external resources) instead of documentation within your site. They appear in the product switcher but navigate users to the specified URL when selected. Define external products directly in `docs.yml` (no product-specific `.yml` file is needed).
41
+
</Info>
42
+
37
43
```bash {4, 7-8}
38
44
fern/
39
45
├─ fern.config.json
@@ -43,6 +49,7 @@ fern/
43
49
├─ ...
44
50
├─ product-a.yml # Contents and navigation for Product A
45
51
└─ product-b.yml # Contents and navigation for Product B
52
+
# No separate yml file needed for external products
46
53
```
47
54
48
55
<CodeBlocks>
@@ -89,45 +96,53 @@ tabs:
89
96
</Step>
90
97
<Step title="Add your product configuration">
91
98
92
-
To define a product, add an item to the `products` list in `docs.yml`, specifying the `display-name` and `path`.
93
-
94
-
The optional parameters are: `image`, `icon`, `subtitle`, `slug`, and `versions`. If you provide both an `image` and an `icon`, the `image` will take precedence.
99
+
To define a product, add an item to the `products` list in `docs.yml`, specifying the `display-name` and either `path` (for internal products) or `href` (for external products).
95
100
101
+
For both internal and external products, `image`, `icon`, and `subtitle` are optional parameters. If you provide both an `image` and an `icon`, the `image` will take precedence. Internal products additionally support the optional `slug` and `versions` parameters.
<Step title="Remove extra navigation from docs.yml">
123
133
124
134
If your `docs.yml` file includes a `navigation` field or a `tabs` field, be sure to remove. Those fields should now belong in the product-specific `.yml` files.
135
+
136
+
<Note>
137
+
External products don't support `navigation` and `tabs` fields.
138
+
</Note>
139
+
125
140
</Step>
126
141
</Steps>
127
142
128
143
### Add versioning to your products
129
144
130
-
You can optionally add versions to your products. Versioned and unversioned products can live next to each other in your site.
145
+
You can optionally add versions to your internal products. Versioned and unversioned products can live next to each other in your site. Versions are not supported for external products.
131
146
132
147
<Note>For standalone versioning without products, see our [Versioning guide](/docs/configuration/versions).</Note>
133
148
@@ -330,4 +345,4 @@ The dropdown menus for product and version selectors can be customized using the
330
345
<img src="webflow-version-selector.avif" alt="Example of a styled version selector" />
0 commit comments