Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions fern/products/docs/pages/api-references/sdk-snippets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,18 @@ Merge.dev is an example of a Fern customer that uses the Snippets API to bring P
## Endpoint request and response snippets

Looking for information on generating API endpoint request and response snippets? See our documentation on [Endpoint Request Snippets](/learn/docs/content/components/request-snippet) and [Endpoint Response Snippets](/learn/docs/content/components/response-snippet).

## Search Integration

You can integrate Fern's documentation search functionality into your own application using our Algolia credentials. Contact us to get access to Algolia credentials specific to your documentation. This allows you to:

- Search through your Fern-generated documentation programmatically
- Integrate documentation search into your dashboard or application
- Access the same search index used on your Fern documentation site

To get started with search integration:
1. Request Algolia credentials from the Fern team
2. Use the provided credentials to initialize the Algolia client in your application
3. Query the search index to retrieve documentation results

The search functionality uses the same Algolia index that powers the search on your Fern documentation site, ensuring consistent results across platforms.
13 changes: 11 additions & 2 deletions fern/products/docs/pages/customization/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,23 @@ It includes built-in filters that let users refine their searches by content typ
- **Guides:** Filters results by non-API reference documentation.
- **Changelog:** Filters results by changelog updates.

If you are using the AI Search feature, the search box also functions as your sites chat window.
If you are using the AI Search feature, the search box also functions as your site's chat window.

<Note>
**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.
</Note>

## Using Fern's Algolia in your application

If you want to integrate Fern documentation search into your own application, you can request Algolia credentials from the Fern team. These credentials will allow you to directly query the same search index that powers your Fern documentation site.

To get started:
1. Contact the Fern team to request Algolia credentials
2. Use the provided credentials to initialize the Algolia client in your application
3. Query the search index using Algolia's API

## Using an alternative search

You can override Fern's search with your own solution.
[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.
To learn more, see [Custom JavaScript](/learn/docs/building-and-customizing-your-docs/custom-css-global-js#custom-javascript).
To learn more, see [Custom JavaScript](/learn/docs/building-and-customizing-your-docs/custom-css-global-js#custom-javascript).