Skip to content
forked from pheralb/svgl

🧩 A beautiful library with SVG logos. Built with Sveltekit & Tailwind CSS.

License

Notifications You must be signed in to change notification settings

lowcoder-org/svgl

 
 

Repository files navigation

Svelte Badge Build Status GitHub stars GitHub issues GitHub forks GitHub PRs Tailwind CSS Badge

🛠️ Stack

🚀 Getting Started

Important

Before submitting the SVG, make sure that you have permission or that the license of the SVG allows you to add it to svgl. If you are not sure, please contact the company or author.

You will need:

  1. Fork this repository and clone it locally:
git clone [email protected]:your_username/svgl.git
  1. Install dependencies:
# Install pnpm globally if you don't have it:
npm install -g pnpm

# and install dependencies:
pnpm install
  1. Go to the static/library folder and add your .svg logo.

Warning

  • Remember to optimize SVG for web, you can use SVGOMG.
  • When you optimize the SVG, make sure that the viewBox is not removed.
  • The size limit for each .svg is 20kb.
  1. Go to the src/data/svgs.ts and add the information about your logo, following the structure:
  • If the logo is a solid color:
{
  "title": "Title",
  "category": "Category",
  "route": "/library/your_logo.svg",
  "url": "Website"
}
  • If the logo has logo + wordmark version:
{
  "title": "Title",
  "category": "Category",
  "route": "/library/your_logo.svg",
  "wordmark": "/library/your_logo_wordmark.svg",
  "url": "Website"
}
  • If the logo/wordmark has light and dark mode:
{
  "title": "Title",
  "category": "Category",
  "route": {
    "light": "/library/your_logo_light.svg",
    "dark": "/library/your_logo_dark.svg"
  },
  "wordmark": {
    "light": "/library/your_wordmark-logo_light.svg",
    "dark": "/library/your_wordmark-logo_dark.svg"
  },
  "url": "Website"
}

Note

  • The list of categories is here: src/types/categories.ts. You can add a new category if you need it.
  • You can add multiple categories to the same logo, for example: "category": ["Social", "Design"] (max 3 categories per logo).

And create a pull request with your logo 🚀.

  1. (Optional) If you want to run the API locally, you will need to create a .env file in the root of the project with the following variables:
SVGL_API_REQUESTS = 1
UPSTASH_REDIS_URL = ""
UPSTASH_REDIS_TOKEN = ""

📦 Extensions

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

Extension Description Created by Link
svgls A CLI for easily adding SVG icons to your project. sujjeee Github Repository
SVGL for Figma Add svgs from svgl to your Figma project. quilljou Figma Plugin
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 Svgl Badge

✌️ Contributing

🔑 License

About

🧩 A beautiful library with SVG logos. Built with Sveltekit & Tailwind CSS.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 55.3%
  • Svelte 38.1%
  • JavaScript 4.4%
  • HTML 1.2%
  • CSS 1.0%