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
Copy file name to clipboardExpand all lines: fern/products/docs/pages/customization/search.mdx
+25-7Lines changed: 25 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,19 +11,37 @@ DocSearch is designed specifically for documentation sites to help users quickly
11
11
DocSearch scans your Fern site's content and builds an index to generate search results.
12
12
It includes built-in filters that let users refine their searches by content type:
13
13
14
-
-**Versions:** For sites with separate documentation for different API versions.
15
-
-**Endpoints:**Filters results by API reference documentation.
16
-
-**Guides:** Filters results by non-API reference documentation.
17
-
-**Changelog:** Filters results by changelog updates.
14
+
-**Versions:** For sites with separate documentation for different API versions
15
+
-**Endpoints:** Filters results by API reference documentation
16
+
-**Guides:** Filters results by non-API reference documentation
17
+
-**Changelog:** Filters results by changelog updates
18
18
19
-
If you are using the AI Search feature, the search box also functions as your site’s chat window.
19
+
If you are using the AI Search feature, the search box also functions as your site's chat window.
20
20
21
21
<Note>
22
22
**Note:** If an article includes the `nofollow` or `noindex`[frontmatter](/learn/docs/content/frontmatter#indexing-properties), it will not be indexed by Algolia DocSearch and won't appear in search results.
23
23
</Note>
24
24
25
+
## Integrating with Algolia
26
+
27
+
If you need to integrate Fern's documentation search into your own application or dashboard, you can request Algolia credentials directly from the Fern team. These credentials will allow you to query the same search index that powers your documentation site's search functionality.
28
+
29
+
### Making Search Requests
30
+
31
+
Once you have your credentials, you can make requests to Algolia's API to search your documentation. The search endpoint follows this pattern:
Contact the Fern team to get your specific application ID and index name. Credentials are provided on a per-customer basis to maintain security.
38
+
39
+
<Note>
40
+
**Note:** Keep your Algolia credentials secure and avoid exposing them in client-side code. Consider implementing a backend proxy to make the Algolia requests.
41
+
</Note>
42
+
25
43
## Using an alternative search
26
44
27
45
You can override Fern's search with your own solution.
28
-
[Here](https://github.com/deepgram/deepgram-docs/blob/main/fern/assets/component.js) is an example of custom JavaScript a customer used to replace the default search with their own implementation and additional features.
29
-
To learn more, see [Custom JavaScript](/learn/docs/building-and-customizing-your-docs/custom-css-global-js#custom-javascript).
46
+
47
+
To learn more, see [Custom JavaScript](/learn/docs/building-and-customizing-your-docs/custom-css-global-js#custom-javascript).
0 commit comments