Skip to content

Commit f3d75b2

Browse files
Add Mintlify integration page for Fern (#1787)
1 parent 376273c commit f3d75b2

File tree

3 files changed

+39
-1
lines changed

3 files changed

+39
-1
lines changed

fern/products/docs/docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,8 @@ navigation:
269269
slug: analytics/mixpanel
270270
- page: Postman
271271
path: ./pages/integrations/postman.mdx
272+
- page: Mintlify
273+
path: ./pages/integrations/mintlify.mdx
272274
- page: LaunchDarkly feature flags
273275
path: ./pages/integrations/feature-flags.mdx
274276
hidden: true
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "Mintlify"
3+
description: "Generate SDKs with Fern and document them with Mintlify"
4+
---
5+
6+
Use Fern to generate SDKs for your API, then document them in Mintlify with automatically enriched code samples.
7+
8+
## How it works
9+
10+
Fern generates SDKs and provides a publicly accessible OpenAPI spec enriched with SDK code samples. Reference this spec in your Mintlify documentation to display SDK usage examples in your API playground.
11+
12+
## Setup
13+
14+
Add the Fern OpenAPI spec URL to your Mintlify `docs.json` configuration:
15+
16+
```json docs.json
17+
{
18+
"anchors": [
19+
{
20+
"name": "API Reference",
21+
"openapi": "https://registry.buildwithfern.com/{org}/{api-name}/openapi/openapi.json",
22+
"url": "api-reference"
23+
}
24+
]
25+
}
26+
```
27+
28+
Replace `{org}` with your organization name and `{api-name}` with your API name from `fern.config.json`.

fern/products/docs/pages/integrations/overview.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@ description: "Integrate with third party platforms for analytics, support, etc."
4747
iconSize={12}
4848
/>
4949

50+
<Card
51+
title="Mintlify"
52+
href="/docs/integrations/mintlify"
53+
horizontal
54+
icon={<img src="https://mintcdn.com/mintlify/e0-N9JebsJpsinlD/logo/light.svg" />}
55+
iconSize={12}
56+
/>
57+
5058
</CardGroup>
5159

5260
## Enabling Analytics
@@ -99,4 +107,4 @@ are available during the workflow run.
99107

100108
<Markdown src="/snippets/enterprise-plan.mdx"/>
101109

102-
If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript).
110+
If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript).

0 commit comments

Comments
 (0)