mirror of
https://github.com/pheralb/svgl.git
synced 2024-11-10 14:46:54 +08:00
📚一个拥有 SVG 徽标的美丽图书馆。使用 Sveltekit 与 Tailwind CSS 构建。
https://svgl.app/
.github | ||
.vscode | ||
check-size | ||
src | ||
static | ||
.eslintignore | ||
.eslintrc.cjs | ||
.gitignore | ||
.npmrc | ||
.prettierignore | ||
.prettierrc | ||
LICENSE | ||
package.json | ||
pnpm-lock.yaml | ||
postcss.config.cjs | ||
prettier.config.cjs | ||
README.md | ||
svelte.config.js | ||
tailwind.config.cjs | ||
tsconfig.json | ||
vercel.json | ||
vite.config.ts |
🛠️ Stack
- Sveltekit - Web development, streamlined.
- Typescript - JavaScript with syntax for types.
- mdsvex - Markdown for Svelte apps.
- Shiki - A beautiful Syntax Highlighter.
- Tailwindcss - A utility-first CSS framework for rapidly building custom designs.
- 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 + phosphor-svelte - A clean and friendly icons libraries.
- svelte-sonner - An opinionated toast component for Svelte.
- @upstash/redis + @upstash/ratelimit - Serverless Redis for developers.
- Vitest - Blazing Fast Unit Test Framework.
🚀 Getting Started
You will need:
- Clone or fork this repository:
git clone git@github.com:pheralb/svgl.git
- Install dependencies:
# with pnpm (recommended):
pnpm install
# with npm:
npm install
- 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.
- 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 🚀.
📦 Projects
A list of projects that use svgl:
Project | Description | Author |
---|---|---|
svgls | A CLI for easily adding SVG icons to your project. | sujjeee |
✌️ Contributing
🔑 License
- MIT.