mirror of
https://github.com/pheralb/svgl.git
synced 2025-12-29 08:01:36 +08:00
📄 Update shadcn/ui docs + add shadcn MCP server config
This commit is contained in:
+57
-3
@@ -1,11 +1,11 @@
|
||||
---
|
||||
title: shadcn/ui Registry
|
||||
title: shadcn/ui
|
||||
description: How to use shadcn/ui to add SVGs to your project.
|
||||
---
|
||||
|
||||
## shadcn/ui Registry
|
||||
## shadcn/ui
|
||||
|
||||
SVGL v5 support [shadcn/ui](https://ui.shadcn.com/) registry, so you can easily add SVGs to your project using their CLI. Add the registry config once and you will be able to install any SVG in `.tsx` using `npm`, `yarn`, `bun` or `pnpm`.
|
||||
SVGL v5 support [shadcn/ui](https://ui.shadcn.com/) registry 🎉, so you can easily add SVGs to your project using [their CLI](https://ui.shadcn.com/docs/cli). Add the registry config once and you will be able to install any SVG in **`.tsx`** using `npm`, `yarn`, `bun` or `pnpm`.
|
||||
|
||||
## Add registry
|
||||
|
||||
@@ -40,3 +40,57 @@ Add multiple SVGs at once:
|
||||
```bash
|
||||
pnpm dlx shadcn@latest add @svgl/sanity @svgl/github @svgl/supabase @svgl/vercel
|
||||
```
|
||||
|
||||
## MCP Server
|
||||
|
||||
You can use the [shadcn MCP server](https://ui.shadcn.com/docs/mcp) to browse, search, and add React SVGs from SVGL registry:
|
||||
|
||||
### Prerequisites
|
||||
|
||||
You need to have `@svgl` in your `components.json` file:
|
||||
|
||||
```json
|
||||
{
|
||||
"registries": {
|
||||
"@svgl": "https://svgl.app/r/{name}.json"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Quick Start
|
||||
|
||||
**With Claude Code**:
|
||||
|
||||
```bash
|
||||
pnpm dlx shadcn@latest mcp init --client claude
|
||||
```
|
||||
|
||||
Then, restart Claude Code. You can use `/mcp` command in Claude Code to debug the MCP server.
|
||||
|
||||
**With Cursor**:
|
||||
|
||||
```bash
|
||||
pnpm dlx shadcn@latest mcp init --client cursor
|
||||
```
|
||||
|
||||
Then, open Cursor Settings and Enable the MCP server for shadcn.
|
||||
|
||||
**With VSCode**:
|
||||
|
||||
```bash
|
||||
pnpm dlx shadcn@latest mcp init --client vscode
|
||||
```
|
||||
|
||||
Then, open `.vscode/mcp.json` and click Start next to the shadcn server.
|
||||
|
||||
### Example Prompts
|
||||
|
||||
Here are some example prompts you can use to add SVGs from SVGL registry:
|
||||
|
||||
```
|
||||
Can you add the "GitHub" SVG from SVGL registry?
|
||||
```
|
||||
|
||||
```
|
||||
Please add React, Svelte and Vue SVGs from SVGL registry.
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user