README.md

📦 Extensions

A list of extensions that use the SVGL API, created by the community:

	Extension	Description	Created by	Link
	SVGL CLI	A CLI for easily adding SVG icons to your project.	sujjeee	GitHub Repository
	SVGL for Framer	Our SVGL plugin for Framer simplifies the use of SVG-based colourful logos. Easily import and easy to use.	Krishna Singh	Framer Marketplace
	SVGL for React	An open-source NPM package that offers a SVGL Logos for React.	ridemountainpig	GitHub Repository
	SVGL for Vue	An open-source NPM package that offers a SVGL Logos for Vue.	selemondev	GitHub Repository
	SVGL for Svelte	An open-source NPM package that offers a SVGL Logos for Svelte.	selemondev	GitHub Repository
	SVGL for Figma	Add svgs from svgl to your Figma project.	quilljou	Figma Plugin
	SVGL for PowerToys	Search & copy SVG logos in PowerToys Run.	SameerJS6	Website
	SVGL for Raycast	Search SVG logos via svgl.	1weiho	Raycast Store
	SVGL for VSCode	SVGL directly in your VSCode.	girlazote	VSCode Marketplace
	SVGL Badge	A beautiful badges with svgl SVG logos.	ridemountainpig	Website
	Magic	AI extension for Cursor & other IDEs	serafimcloud	Website
	SVGL for PowerShell	PowerShell extension to quickly get svgl logos anywhere	Bart Spaans	GitHub Repository
	SVGL for Flow Launcher	Search & copy SVG logos in Flow Launcher	AF_Askar	GitHub Repository

🛠️ Stack

• Sveltekit + Svelte 5 - Web development, streamlined.
• Typescript - JavaScript with syntax for types.
• Content-Collections - Transform your content into type-safe data collections and say goodbye to manual data fetching and parsing.
• Shiki - A beautiful Syntax Highlighter.
• Tailwind CSS - A utility-first CSS framework for rapidly building custom designs.
• bits-ui - A collection of headless components for Svelte.
• clsx + tailwind-merge inspired by shadcn/ui - A tiny utility for constructing className strings conditionally.
• Prettier + prettier-plugin-tailwindcss - An opinionated code formatter.
• Lucide Icons - Beautiful & consistent icons.
• svelte-sonner - An opinionated toast component for Svelte.
• Hono - Fast, lightweight, built on Web Standards. Support for any JavaScript runtime.
• @upstash/redis + @upstash/ratelimit - Serverless Redis for developers.

🚀 Getting Started

You will need:

• Node.js 20+.
• Git.

1. Fork this repository and clone it locally:

git clone git@github.com:your_username/svgl.git

2. Install dependencies:

# Install pnpm globally if you don't have it:
npm install -g pnpm

# and install dependencies:
pnpm install

3. Go to the static/library folder and add your .svg logo.

4. Go to the src/data/svgs.ts and add the information about your logo, following the structure:

• Simple logo:

{
  title: 'Title',
  category: 'Category',
  route: '/library/your_logo.svg',
  url: 'Website'
}

• Simple logo + wordmark:

{
  title: 'Title',
  category: 'Category',
  route: '/library/your_logo.svg',
  wordmark: '/library/your_logo_wordmark.svg',
  url: 'Website'
}

• Logo (light & dark mode):

{
  title: 'Title',
  category: 'Category',
  route: {
    light: '/library/your_logo_light.svg',
    dark: '/library/your_logo_dark.svg'
  },
  url: 'Website'
}

• Wordmark (light & dark mode):

{
  title: 'Title',
  category: 'Category',
  wordmark: {
    light: '/library/your_logo_light.svg',
    dark: '/library/your_logo_dark.svg'
  },
  url: 'Website'
}

• Full example with all properties:

{
  title: 'Title',
  category: 'Category',
  route: {
    light: '/library/your_logo_light.svg',
    dark: '/library/your_logo_dark.svg'
  },
  wordmark: {
    light: '/library/your_logo_wordmark_light.svg',
    dark: '/library/your_logo_wordmark_dark.svg'
  },
  url: 'Website'
}

• Add brand guidelines (where to find the images, how to use it, colors, fonts...):

{
  title: 'Title',
  category: 'Category',
  route: '/library/your_logo.svg',
  wordmark: '/library/your_logo_wordmark.svg',
  brandUrl: 'https://assets.website.com/brand-guidelines',
  url: 'Website'
}

• Add Loftlyy brand URL:

Loftlyy is a brand identity reference site — discover and explore brand colors, typography, logos, and design systems. Created by preetsuthar17.

{
  title: 'Title',
  category: 'Category',
  route: '/library/your_logo.svg',
  wordmark: '/library/your_logo_wordmark.svg',
  loftlyyUrl: 'https://www.loftlyy.com/en/brand-name',
  url: 'Website'
}

And create a pull request with your logo ✨.

🧑‍🚀 Getting Started with API

1. Go to the api-routes folder and install the dependencies with pnpm:

cd api-routes
pnpm install

2. Create a .dev.vars env file in the api-routes folder with the following variables:

# .dev.vars
SVGL_API_REQUESTS = 1
UPSTASH_REDIS_URL = ""
UPSTASH_REDIS_TOKEN = ""

• Create a Upstash account.
• Create a Upstash Redis Database.

3. Run the development server:

pnpm dev

✌️ Contributing

🔑 License

• MIT.