diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index 4e17e4fc9..b0b49246b 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -269,6 +269,8 @@ navigation: slug: analytics/mixpanel - page: Postman path: ./pages/integrations/postman.mdx + - page: Mintlify + path: ./pages/integrations/mintlify.mdx - page: LaunchDarkly feature flags path: ./pages/integrations/feature-flags.mdx hidden: true diff --git a/fern/products/docs/pages/integrations/mintlify.mdx b/fern/products/docs/pages/integrations/mintlify.mdx new file mode 100644 index 000000000..0c675fc31 --- /dev/null +++ b/fern/products/docs/pages/integrations/mintlify.mdx @@ -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`. diff --git a/fern/products/docs/pages/integrations/overview.mdx b/fern/products/docs/pages/integrations/overview.mdx index d2b0ec19f..a5830efcf 100644 --- a/fern/products/docs/pages/integrations/overview.mdx +++ b/fern/products/docs/pages/integrations/overview.mdx @@ -47,6 +47,14 @@ description: "Integrate with third party platforms for analytics, support, etc." iconSize={12} /> +} + iconSize={12} +/> + ## Enabling Analytics @@ -99,4 +107,4 @@ are available during the workflow run. -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).