mirror of
https://github.com/pheralb/svgl.git
synced 2024-11-10 14:46:54 +08:00
📝 Update docs
This commit is contained in:
parent
7887663463
commit
03dc2bb844
31
README.md
31
README.md
@ -92,6 +92,8 @@ pnpm install
|
|||||||
|
|
||||||
4. Go to the [**`src/data/svgs.ts`**](https://github.com/pheralb/svgl/blob/main/src/data/svgs.ts) and add the information about your logo, following the structure:
|
4. Go to the [**`src/data/svgs.ts`**](https://github.com/pheralb/svgl/blob/main/src/data/svgs.ts) and add the information about your logo, following the structure:
|
||||||
|
|
||||||
|
- If the logo is a solid color:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"title": "Title",
|
"title": "Title",
|
||||||
@ -101,7 +103,7 @@ pnpm install
|
|||||||
},
|
},
|
||||||
```
|
```
|
||||||
|
|
||||||
or to support a different logo for light and dark themes:
|
- If the logo has light and dark mode:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@ -115,6 +117,31 @@ or to support a different logo for light and dark themes:
|
|||||||
},
|
},
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- If the logo has logo + wordmark version:
|
||||||
|
|
||||||
|
```json
|
||||||
|
// Only solid color:
|
||||||
|
{
|
||||||
|
"title": "Title",
|
||||||
|
"category": "Category",
|
||||||
|
"route": "/library/your_logo.svg",
|
||||||
|
"wordmark": "/library/your_logo_wordmark.svg",
|
||||||
|
"url": "Website"
|
||||||
|
},
|
||||||
|
|
||||||
|
// Add light/dark mode:
|
||||||
|
{
|
||||||
|
"title": "Title",
|
||||||
|
"category": "Category",
|
||||||
|
"route": "/library/your_logo.svg",
|
||||||
|
"wordmark": {
|
||||||
|
"light": "/library/your_logo_wordmark_light.svg",
|
||||||
|
"dark": "/library/your_logo_wordmark_dark.svg"
|
||||||
|
},
|
||||||
|
"url": "Website"
|
||||||
|
},
|
||||||
|
```
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> The list of categories is here: [`src/types/categories.ts`](https://github.com/pheralb/svgl/blob/main/src/types/categories.ts). You can add a new category if you need it.
|
> The list of categories is here: [`src/types/categories.ts`](https://github.com/pheralb/svgl/blob/main/src/types/categories.ts). You can add a new category if you need it.
|
||||||
|
|
||||||
@ -136,7 +163,7 @@ UPSTASH_REDIS_TOKEN = ""
|
|||||||
A list of extensions that use the [svgl API](https://svgl.app/api), created by the community:
|
A list of extensions that use the [svgl API](https://svgl.app/api), created by the community:
|
||||||
|
|
||||||
| | Extension | Description | Created by | Link |
|
| | Extension | Description | Created by | Link |
|
||||||
| ---- | -------------- | -------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------- | ---------------- | -------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------- |
|
||||||
| <img src="https://github.com/pheralb/svgl/blob/main/static/library/svgl.svg" height="25" /> | svgls | A CLI for easily adding SVG icons to your project. | [sujjeee](https://twitter.com/sujjeeee) | [Github Repository](https://github.com/sujjeee/svgls) |
|
| <img src="https://github.com/pheralb/svgl/blob/main/static/library/svgl.svg" height="25" /> | svgls | A CLI for easily adding SVG icons to your project. | [sujjeee](https://twitter.com/sujjeeee) | [Github Repository](https://github.com/sujjeee/svgls) |
|
||||||
| <img src="https://github.com/pheralb/svgl/blob/main/static/library/figma.svg" height="25" /> | SVGL for Figma | Add svgs from svgl to your Figma project. | [quilljou](https://twitter.com/quillzhou) | [Figma Plugin](https://www.figma.com/community/plugin/1320306989350693206/svgl) |
|
| <img src="https://github.com/pheralb/svgl/blob/main/static/library/figma.svg" height="25" /> | SVGL for Figma | Add svgs from svgl to your Figma project. | [quilljou](https://twitter.com/quillzhou) | [Figma Plugin](https://www.figma.com/community/plugin/1320306989350693206/svgl) |
|
||||||
| <img src="https://github.com/pheralb/svgl/blob/main/static/library/raycast.svg" height="25" /> | SVGL for Raycast | Search SVG logos via svgl. | [1weiho](https://twitter.com/1weiho) | [Raycast Store](https://www.raycast.com/davidho0403/svgl) |
|
| <img src="https://github.com/pheralb/svgl/blob/main/static/library/raycast.svg" height="25" /> | SVGL for Raycast | Search SVG logos via svgl. | [1weiho](https://twitter.com/1weiho) | [Raycast Store](https://www.raycast.com/davidho0403/svgl) |
|
||||||
|
Loading…
Reference in New Issue
Block a user