📚一个拥有 SVG 徽标的美丽图书馆。使用 Sveltekit 与 Tailwind CSS 构建。 https://svgl.app/
Go to file
2023-12-23 15:43:54 +08:00
.github ⚙️ Update workflow. 2023-12-17 14:41:57 +00:00
.vscode 🔧 Update vscode settings. 2023-12-13 13:37:23 +00:00
check-size 🔧 Update check-size utility, fix bugs. 2023-12-16 21:16:52 +00:00
src feat: add figma plugin 2023-12-23 15:43:54 +08:00
static tether svg added 2023-12-21 15:38:36 +01:00
.eslintignore 🧡 Initial commit with Sveltekit. 2023-03-14 21:08:22 +00:00
.eslintrc.cjs 🔨 Update eslint config. 2023-07-07 09:16:54 +01:00
.gitignore 🐛 Merge branch 'main' of github.com:pheralb/svgl into next. 2023-12-16 17:45:22 +00:00
.npmrc 🧡 Initial commit with Sveltekit. 2023-03-14 21:08:22 +00:00
.prettierignore 🧡 Initial commit with Sveltekit. 2023-03-14 21:08:22 +00:00
.prettierrc 🛠️ Update prettier json. 2023-03-15 11:27:46 +00:00
LICENSE 📝 Update license. 2023-03-20 00:39:40 +00:00
package.json feat: add figma plugin 2023-12-23 15:43:54 +08:00
pnpm-lock.yaml 📦 Add bits-ui & jszip. 2023-12-17 21:02:50 +00:00
postcss.config.cjs 🛠️ Add tailwindcss. 2023-03-15 11:28:22 +00:00
prettier.config.cjs 🛠️ Add prettier-plugin-tailwindcss. 2023-03-15 12:11:13 +00:00
README.md 📝 Update readme docs. 2023-12-18 01:55:20 +00:00
svelte.config.js 🔧 Update vite-plugin-svelte. 2023-12-16 17:07:44 +00:00
tailwind.config.cjs 🎨 Add new fonts. 2023-12-16 22:36:17 +00:00
tsconfig.json feat: add figma plugin 2023-12-23 15:43:54 +08:00
vercel.json 🛠 Create vercel.json. 2023-03-16 10:23:17 +00:00
vite.config.ts 🚀 Initial sveltekit config. 2023-03-15 11:29:15 +00:00

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 git@github.com: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.
  • 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 🚀.

  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 = ""

💻 Terminal

SVG files can also be accessed directly from the terminal using svgls CLI.

Quick start

If you are using yarn or npm, run this command:

npx svgls add
# or
pnpm dlx svgls add

For more details, check out the GitHub repository created by sujjeee.

✌️ Contributing

🔑 License