svgl/README.md
2023-12-11 21:34:15 -03:00

3.6 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 your favorite package manager:
# with npm:
npm install

# with pnpm:
pnpm install

# with ultra:
ultra install

# with yarn:
yarn install
  1. Go to the static/library folder and add your .svg logo. Remember to optimize SVG for web use, you can use SVGOMG.

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

Important

To avoid conflicts with other svgs IDs, generate a short random number for the id: Generate (only check 'include numbers').

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

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

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

And create a pull request with your logo 🚀.

✌️ Contributing

🔑 License