Launch Week II Day 2: Snippets V2

Josh Kim

Josh Kim

Operations and GTM

blog thumbnail

Day 2 of Launch Week II brings Snippets V2 🚀.

Snippets V2 offers more flexibility and performance while being rebuilt from the ground up to resemble the import experience that developers know and love.

Outside of our existing snippets V1 setup, we now support fully reusable components and variables.

Why it matters

An important principle in software development is DRY (Don’t Repeat Yourself). We believe that the same principle should be applied when building docs.

Snippets allow you to avoid repeating the same content in multiple places by storing variables that can be easily called.

Leveraging more of MDX, you can now directly import external components and variables. This setup can be a powerful tool when versioning your documentation, where only certain properties may change.

Getting started

To try Snippets V2 for your docs, upgrade your CLI with npm i -g mintlify@latest. For more technical details for how to implement Snippet V2, check out our documentation.

For Reusable Components

  1. Create a new file in the snippets directory
  2. Inside that file, add whatever content you would like to be reused. Optionally, you can add variables that can be filled in via props

Hello World! My keyword of the day is {word}

  1. Import the snippet into the destination file and pass in the props
---
title: My title
description: My Description
---
import MySnippet from "/snippets/mysnippet.mdx";

Lorem ipsum dolor sit amet.

<MySnippet word="bananas" />

For Reusable Variables

  1. Create a new file in the snippets directory
  2. Export a variable from your snippet file:
---
snippet: true
---

export const myName = "my name";

export const myObject = { fruit: "strawberries" };
  1. Import the snippet from your destination file and use the variable:
---
title: My title
description: My Description
---

import { myName, myObject } from "../path/to/custom-variables.mdx";

Hello, my name is {myName} and I like {myObject.fruit}.

That’s it for Day 2 🫶. To stay updated for the rest of Launch Week, follow us on Twitter or join our community!