svgl/README.md
2023-12-16 21:26:26 +00:00

3.7 KiB

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

🛠️ Stack

🚀 Getting Started

You will need:

  1. Clone or fork this repository:
git clone git@github.com:pheralb/svgl.git
  1. Install dependencies:
# with pnpm (recommended):
pnpm install

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

Warning

  • Remember to optimize SVG for web, you can use SVGOMG.
  • The size limit for each .svg is 25kb.
  1. Go to the src/data/svgs.ts and add the information about your logo, following the structure:
{
  "title": "Title",
  "category": "Category",
  "route": "/library/your_logo.svg",
  "url": "Website"
},

or to support a different logo for light and dark themes:

{
  "title": "Title",
  "category": "Category",
  "route": {
    "light": "/library/your_logo_light.svg",
    "dark": "/library/your_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.

And create a pull request with your logo 🚀.

✌️ Contributing

🔑 License