Skip to content

Commit c070561

Browse files
🌿 Fern Scribe: Add documentation on algolia integration... (#237)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Devin Logan <[email protected]>
1 parent 9611216 commit c070561

File tree

2 files changed

+26
-8
lines changed

2 files changed

+26
-8
lines changed

‎fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ Fern AI Search indexes your documentation and provides an interface for your use
5858

5959
## Pricing
6060

61-
AI Search is available on the [Pro plan](https://buildwithfern.com/pricing#Docs) of Fern Docs. Billing is by usage.
61+
AI Search is available on the [Pro plan](https://buildwithfern.com/pricing#Docs) of Fern Docs. Billing is by usage.

‎fern/products/docs/pages/customization/search.mdx‎

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,37 @@ DocSearch is designed specifically for documentation sites to help users quickly
1111
DocSearch scans your Fern site's content and builds an index to generate search results.
1212
It includes built-in filters that let users refine their searches by content type:
1313

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
1818

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.
2020

2121
<Note>
2222
**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.
2323
</Note>
2424

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:
32+
33+
```
34+
https://[APPLICATION_ID]-dsn.algolia.net/1/indexes/[INDEX_NAME]/query
35+
```
36+
37+
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+
2543
## Using an alternative search
2644

2745
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

Comments
 (0)