mirror of
https://github.com/lucide-icons/lucide.git
synced 2026-05-18 09:34:43 +02:00
docs(readme): Update readme files (#4320)
* Update readme * Update vue readme file * Update readme files Co-authored-by: Copilot <copilot@github.com> * Update badge paths * Update docs paths * Update docs/.vitepress/data/packageData.json Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update packages/svelte/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <copilot@github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
26
README.md
26
README.md
@@ -7,9 +7,9 @@
|
||||
</a>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://github.com/lucide-icons/lucide/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/lucide" alt="license"></a>
|
||||
<a href="https://github.com/lucide-icons/lucide/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-ISC-green" alt="license"></a>
|
||||
<a href="https://www.figma.com/community/plugin/939567362549682242/Lucide-Icons"><img src="https://img.shields.io/badge/Figma-F24E1E?logo=figma&logoColor=white" alt="figma installs"></a>
|
||||
<a href="https://github.com/lucide-icons/lucide/actions/workflows/release.yml"><img src="https://github.com/lucide-icons/lucide/actions/workflows/release.yml/badge.svg" alt="build status"></a>
|
||||
<a href="https://github.com/lucide-icons/lucide/actions/workflows/ci.yml"><img src="https://github.com/lucide-icons/lucide/actions/workflows/ci.yml/badge.svg" alt="build status"></a>
|
||||
<a href="https://discord.gg/EH6nSts"><img src="https://img.shields.io/discord/723074157486800936?label=chat&logo=discord&logoColor=%23ffffff&colorB=%237289DA" alt="discord chat"></a>
|
||||
</p>
|
||||
<p align="center">
|
||||
@@ -26,22 +26,22 @@
|
||||
|
||||
# Lucide
|
||||
|
||||
Lucide is an open-source icon library that provides 1000+ vector (svg) files for displaying icons and symbols in digital and non-digital projects. The library aims to make it easier for designers and developers to incorporate icons into their projects by providing several official [packages](https://lucide.dev/packages) to make it easier to use these icons in your project.
|
||||
Lucide is an open-source icon library that provides 1600+ vector (svg) files for displaying icons and symbols in digital and non-digital projects. The library aims to make it easier for designers and developers to incorporate icons into their projects by providing several official [packages](https://lucide.dev/packages) to make it easier to use these icons in your project.
|
||||
|
||||
## Packages
|
||||
|
||||
| Logo | Package | Version | Downloads | Links |
|
||||
| ---- | ------- | ------- | --------- | ----- |
|
||||
| <img src="https://lucide.dev/framework-logos/js.svg" alt="JS logo" width="48"> | **`lucide`** | [](https://www.npmjs.com/package/lucide) |  | [Docs](https://lucide.dev/guide/packages/lucide) · [Source](./packages/lucide) |
|
||||
| <img src="https://lucide.dev/framework-logos/react.svg" alt="React logo" width="48"> | **`lucide-react`** | [](https://www.npmjs.com/package/lucide-react) |  | [Docs](https://lucide.dev/guide/packages/lucide-react) · [Source](./packages/lucide-react) |
|
||||
| <img src="https://lucide.dev/framework-logos/vue.svg" alt="Vue logo" width="48"> | **`lucide-vue-next`** | [](https://www.npmjs.com/package/lucide-vue-next) |  | [Docs](https://lucide.dev/guide/packages/lucide-vue-next) · [Source](./packages/lucide-vue-next) |
|
||||
| <img src="https://lucide.dev/framework-logos/svelte.svg" alt="Svelte logo" width="48"> | **`lucide-svelte`** | [](https://www.npmjs.com/package/lucide-svelte) |  | [Docs](https://lucide.dev/guide/packages/lucide-svelte) · [Source](./packages/lucide-svelte) |
|
||||
| <img src="https://lucide.dev/framework-logos/solid.svg" alt="Solid logo" width="48"> | **`lucide-solid`** | [](https://www.npmjs.com/package/lucide-solid) |  | [Docs](https://lucide.dev/guide/packages/lucide-solid) · [Source](./packages/lucide-solid) |
|
||||
| <img src="https://lucide.dev/framework-logos/preact.svg" alt="Preact logo" width="48"> | **`lucide-preact`** | [](https://www.npmjs.com/package/lucide-preact) |  | [Docs](https://lucide.dev/guide/packages/lucide-preact) · [Source](./packages/lucide-preact) |
|
||||
| <img src="https://lucide.dev/framework-logos/react-native.svg" alt="React Native logo" width="48"> | **`lucide-react-native`** | [](https://www.npmjs.com/package/lucide-react-native) |  | [Docs](https://lucide.dev/guide/packages/lucide-react-native) · [Source](./packages/lucide-react-native) |
|
||||
| <img src="https://lucide.dev/framework-logos/angular.svg" alt="Angular logo" width="48"> | **`lucide-angular`** | [](https://www.npmjs.com/package/lucide-angular) |  | [Docs](https://lucide.dev/guide/packages/lucide-angular) · [Source](./packages/lucide-angular) |
|
||||
| <img src="https://lucide.dev/framework-logos/astro.svg" alt="Astro logo" width="48"> | **`@lucide/astro`** | [](https://www.npmjs.com/package/@lucide/astro) |  | [Docs](https://lucide.dev/guide/packages/lucide-astro) · [Source](./packages/astro) |
|
||||
| <img src="https://lucide.dev/framework-logos/svg.svg" alt="SVG logo" width="48"> | **`lucide-static`** | [](https://www.npmjs.com/package/lucide-static) |  | [Docs](https://lucide.dev/guide/packages/lucide-static) · [Source](./packages/lucide-static) |
|
||||
| <img src="https://lucide.dev/framework-logos/js.svg" alt="JS logo" width="48"> | **`lucide`** | [](https://www.npmjs.com/package/lucide) |  | [Docs](https://lucide.dev/guide/lucide) · [Source](./packages/lucide) |
|
||||
| <img src="https://lucide.dev/framework-logos/react.svg" alt="React logo" width="48"> | **`lucide-react`** | [](https://www.npmjs.com/package/lucide-react) |  | [Docs](https://lucide.dev/guide/react) · [Source](./packages/lucide-react) |
|
||||
| <img src="https://lucide.dev/framework-logos/vue.svg" alt="Vue logo" width="48"> | **`@lucide/vue`** | [](https://www.npmjs.com/package/@lucide/vue) |  | [Docs](https://lucide.dev/guide/vue) · [Source](./packages/vue) |
|
||||
| <img src="https://lucide.dev/framework-logos/svelte.svg" alt="Svelte logo" width="48"> | **`@lucide/svelte`** | [](https://www.npmjs.com/package/@lucide/svelte) |  | [Docs](https://lucide.dev/guide/svelte) · [Source](./packages/@lucide/svelte) |
|
||||
| <img src="https://lucide.dev/framework-logos/solid.svg" alt="Solid logo" width="48"> | **`lucide-solid`** | [](https://www.npmjs.com/package/lucide-solid) |  | [Docs](https://lucide.dev/guide/solid) · [Source](./packages/lucide-solid) |
|
||||
| <img src="https://lucide.dev/framework-logos/preact.svg" alt="Preact logo" width="48"> | **`lucide-preact`** | [](https://www.npmjs.com/package/lucide-preact) |  | [Docs](https://lucide.dev/guide/preact) · [Source](./packages/lucide-preact) |
|
||||
| <img src="https://lucide.dev/framework-logos/react-native.svg" alt="React Native logo" width="48"> | **`lucide-react-native`** | [](https://www.npmjs.com/package/lucide-react-native) |  | [Docs](https://lucide.dev/guide/react-native) · [Source](./packages/lucide-react-native) |
|
||||
| <img src="https://lucide.dev/framework-logos/angular.svg" alt="Angular logo" width="48"> | **`@lucide/angular`** | [](https://www.npmjs.com/package/@lucide/angular) |  | [Docs](https://lucide.dev/guide/angular) · [Source](./packages/angular) |
|
||||
| <img src="https://lucide.dev/framework-logos/astro.svg" alt="Astro logo" width="48"> | **`@lucide/astro`** | [](https://www.npmjs.com/package/@lucide/astro) |  | [Docs](https://lucide.dev/guide/astro) · [Source](./packages/astro) |
|
||||
| <img src="https://lucide.dev/framework-logos/svg.svg" alt="SVG logo" width="48"> | **`lucide-static`** | [](https://www.npmjs.com/package/lucide-static) |  | [Docs](https://lucide.dev/guide/static) · [Source](./packages/lucide-static) |
|
||||
|
||||
### Figma
|
||||
|
||||
|
||||
@@ -50,20 +50,21 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"lucide-svelte": {
|
||||
"@lucide/svelte": {
|
||||
"order": 3,
|
||||
"icon": "svelte",
|
||||
"docsAlias": "svelte",
|
||||
"packageDirname": "svelte",
|
||||
"shields": [
|
||||
{
|
||||
"alt": "npm",
|
||||
"src": "https://img.shields.io/npm/v/lucide-svelte",
|
||||
"href": "https://www.npmjs.com/package/lucide-svelte"
|
||||
"src": "https://img.shields.io/npm/v/@lucide/svelte",
|
||||
"href": "https://www.npmjs.com/package/@lucide/svelte"
|
||||
},
|
||||
{
|
||||
"alt": "npm",
|
||||
"src": "https://img.shields.io/npm/dw/lucide-svelte",
|
||||
"href": "https://www.npmjs.com/package/lucide-svelte"
|
||||
"src": "https://img.shields.io/npm/dw/@lucide/svelte",
|
||||
"href": "https://www.npmjs.com/package/@lucide/svelte"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -119,24 +120,6 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"lucide-angular": {
|
||||
"order": 7,
|
||||
"icon": "angular-old",
|
||||
"description": "Our legacy Angular package with a module based API.",
|
||||
"documentation": "https://v0.lucide.dev/guide/packages/lucide-angular",
|
||||
"shields": [
|
||||
{
|
||||
"alt": "npm",
|
||||
"src": "https://img.shields.io/npm/v/lucide-angular",
|
||||
"href": "https://www.npmjs.com/package/lucide-angular"
|
||||
},
|
||||
{
|
||||
"alt": "npm",
|
||||
"src": "https://img.shields.io/npm/dw/lucide-angular",
|
||||
"href": "https://www.npmjs.com/package/lucide-angular"
|
||||
}
|
||||
]
|
||||
},
|
||||
"lucide-preact": {
|
||||
"order": 8,
|
||||
"icon": "preact",
|
||||
@@ -209,4 +192,4 @@
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -12,7 +12,7 @@ Lucide icon library for Angular applications.
|
||||
|
||||
[](https://www.npmjs.com/package/@lucide/angular)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
|
||||
@@ -12,7 +12,7 @@ Lucide icon library for Astro sites and applications.
|
||||
|
||||
[](https://www.npmjs.com/package/@lucide/astro)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ Lucide helper library that exports icon data.
|
||||
<div align="center">
|
||||
[](https://www.npmjs.com/package/@lucide/icons)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
|
||||
@@ -12,7 +12,7 @@ Lucide icon library for Angular applications.
|
||||
|
||||
[](https://www.npmjs.com/package/lucide-angular)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
|
||||
@@ -12,7 +12,7 @@ Lucide icon library for Preact applications.
|
||||
|
||||
[](https://www.npmjs.com/package/lucide-preact)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
|
||||
@@ -12,7 +12,7 @@ Lucide icon library for React Native applications.
|
||||
|
||||
[](https://www.npmjs.com/package/lucide-react-native)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
|
||||
@@ -12,7 +12,7 @@ Lucide icon library for React applications.
|
||||
|
||||
[](https://www.npmjs.com/package/lucide-react)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
|
||||
@@ -12,7 +12,7 @@ Lucide icon library for Solid applications.
|
||||
|
||||
[](https://www.npmjs.com/package/lucide-solid)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
|
||||
@@ -12,7 +12,7 @@ Lucide icon library with static assets for web applications.
|
||||
|
||||
[](https://www.npmjs.com/package/lucide-static)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
|
||||
@@ -12,7 +12,7 @@ Lucide icon library for Svelte applications.
|
||||
|
||||
[](https://www.npmjs.com/package/lucide-svelte)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
@@ -46,6 +46,7 @@ yarn add lucide-svelte
|
||||
```sh
|
||||
bun add lucide-svelte
|
||||
```
|
||||
|
||||
> For Svelte 5, check out [`@lucide/svelte`](https://www.npmjs.com/package/@lucide/svelte) package.
|
||||
|
||||
## Documentation
|
||||
|
||||
@@ -12,7 +12,7 @@ Lucide icon library for Vue applications.
|
||||
|
||||
[](https://www.npmjs.com/package/lucide-vue-next)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
|
||||
@@ -12,7 +12,7 @@ Lucide icon library for web applications.
|
||||
|
||||
[](https://www.npmjs.com/package/lucide)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
|
||||
@@ -10,9 +10,9 @@ Lucide icon library for Svelte 5 applications.
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://www.npmjs.com/package/lucide-svelte)
|
||||
[](https://www.npmjs.com/package/@lucide/svelte)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
@@ -46,6 +46,7 @@ yarn add @lucide/svelte
|
||||
```sh
|
||||
bun add @lucide/svelte
|
||||
```
|
||||
|
||||
> `@lucide/svelte` is only for Svelte 5, for Svelte 4 use the [`lucide-svelte`](https://www.npmjs.com/package/lucide-svelte) package.
|
||||
|
||||
## Documentation
|
||||
|
||||
@@ -8,6 +8,13 @@
|
||||
Lucide icon library for Vue applications.
|
||||
</p>
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://www.npmjs.com/package/@lucide/vue)
|
||||

|
||||
[](https://lucide.dev/license)
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://lucide.dev/guide/">About</a>
|
||||
·
|
||||
@@ -20,7 +27,7 @@ Lucide icon library for Vue applications.
|
||||
|
||||
# Lucide Vue
|
||||
|
||||
Implementation of the lucide icon library for Vue 3 applications.
|
||||
Implementation of the lucide icon library for Vue applications.
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
Reference in New Issue
Block a user