Skip to navigation

Mintlify compatibility

View as Markdown

Fern renders pages written with Mintlify components without changes.

Components that work as-is

These components have the same name and props in Fern:

<Accordion>, <AccordionGroup>, <Badge>, <Callout>, <Card>, <CardGroup>, <Check>, <CodeGroup>, <Color>, <Frame>, <GitHub.Repo>, <Icon>, <Info>, <Mermaid>, <Note>, <ParamField>, <Prompt>, <Step>, <Steps>, <Tab>, <Tabs>, <Tile>, <Tip>, <Tooltip>, <Update>, <Warning>

Aliased components

These render through a Fern component. They work unchanged, but you can switch to the Fern name:

MintlifyFern
<ResponseField name="..."><ParamField path="...">
<Expandable><Accordion>
<Danger><Error>
<Columns><ColumnGroup>
<Tree>, <FileTree>, <Tree.Folder>, <Tree.File><Files>, <Folder>, <File>
<RequestExample>, <ResponseExample><CodeGroup>
<View title="..."><Tabs> and <Tab title="...">
<Panel><Aside>
<Visibility for="humans"><llms-ignore>
<Visibility for="agents"><llms-only>
<Visibility for="signed-in"><If loggedIn={true}>
<Visibility for="signed-out"><If loggedIn={false}>
<Visibility for={{ groups: [...] }}><If roles={[...]}>
Card imgCard src
Badge colorBadge intent

Move to Fern components

1

Rename the tags

Replace each Mintlify tag in the table above with its Fern equivalent, including the closing tag.

2

Rename the props

On <ParamField>, rename name to path. On <Card>, rename img to src. On <Badge>, replace color with an intent.

3

Wrap adjacent views in tabs

Wrap each run of adjacent <View> elements in one <Tabs>, and turn each <View> into a <Tab>.

4

Preview the site

Run fern docs dev and check the converted pages.