












Mintlify launched a VSCode extension that provides IntelliSense and snippets for their component library, making it easier to write documentation with components like Cards, Steps, Tabs, and callouts. The extension supports both individual components and "Surround" snippets for content-encapsulating components, streamlining the documentation writing process directly within the developer's preferred editor.
Today, we're thrilled to introduce the Mintlify MDX VSCode extension.
At Mintlify, we maintain a components library designed to make your documentation beautiful out-of-the-box.
Now, you can supercharge editing and maintaining your Mintlify docs by easily invoking these components within VSCode.
![]()
To add components, simply type < followed by a few characters for the intended component. Intellisense will appear to guide you to the full component name.
Currently, we support:
- Components: `Card`, `Steps`, `Tabs`, `ParamField`, `ResponseField`
- Callouts: `Note`, `Warning`, `Info`, `Tip`, `Check`
For components that need to encapsulate content (e.g., `CardGroup`, `CodeGroup`), you can activate these "Surround" snippets as follows:
![]()
To quickly trigger the extension modal, you can set a keyboard shortcut for **"Snippets: Surround with Snippet**.
![]()
Component discovery often requires extensive review of documentation.
Now, with the Mintlify MDX VSCode extension at your fingertips, you can easily incorporate components as you are writing your documentation.
Forgot how to add the Steps component to your docs? No worries— you can now easily add the associated snippet without needing to remember the syntax.
You can expect more upgrades to the extension in the upcoming weeks!
The VSCode extension is now available on the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets) for all of our users.
To stay tuned with future updates, follow our Twitter. Join the community to request features and show us some love!
此内容由惯性聚合(RSS阅读器)自动聚合整理,仅供阅读参考。 原文来自 — 版权归原作者所有。