-
Notifications
You must be signed in to change notification settings - Fork 3
Add Mintlify integration page for Fern #1787
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 4 commits
e262a4d
5a2ff74
880388d
1b8a7cb
f926562
6787aec
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -269,6 +269,9 @@ navigation: | |
| slug: analytics/mixpanel | ||
| - page: Postman | ||
| path: ./pages/integrations/postman.mdx | ||
| - page: Mintlify | ||
| path: ./pages/integrations/docs/mintlify.mdx | ||
|
||
| slug: docs/mintlify | ||
|
||
| - page: LaunchDarkly feature flags | ||
| path: ./pages/integrations/feature-flags.mdx | ||
| hidden: true | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| title: "Mintlify" | ||
| description: "Generate SDKs with Fern and document them with Mintlify" | ||
| --- | ||
|
|
||
| Use Fern to generate SDKs for your API, then document them in Mintlify with automatically enriched code samples. | ||
|
|
||
| ## How it works | ||
|
|
||
| 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. | ||
|
|
||
| ## Setup | ||
|
|
||
| Add the Fern OpenAPI spec URL to your Mintlify `docs.json` configuration: | ||
|
|
||
| ```json docs.json | ||
| { | ||
| "anchors": [ | ||
| { | ||
| "name": "API Reference", | ||
| "openapi": "https://registry.buildwithfern.com/{org}/{api-name}/openapi/openapi.json", | ||
| "url": "api-reference" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| Replace `{org}` with your organization name and `{api-name}` with your API name from `fern.config.json`. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -47,6 +47,14 @@ description: "Integrate with third party platforms for analytics, support, etc." | |
| iconSize={12} | ||
| /> | ||
|
|
||
| <Card | ||
| title="Mintlify" | ||
| href="/docs/integrations/docs/mintlify" | ||
|
||
| horizontal | ||
| icon={<img src="https://mintcdn.com/mintlify/e0-N9JebsJpsinlD/logo/light.svg" />} | ||
| iconSize={12} | ||
| /> | ||
|
|
||
| </CardGroup> | ||
|
|
||
| ## Enabling Analytics | ||
|
|
@@ -99,4 +107,4 @@ are available during the workflow run. | |
|
|
||
| <Markdown src="/snippets/enterprise-plan.mdx"/> | ||
|
|
||
| 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). | ||
| 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). | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
undo this change