Skip to content

Commit

Permalink
docs: progress on documentation of lucide-astro
Browse files Browse the repository at this point in the history
  • Loading branch information
MoustaphaDev committed Dec 7, 2024
1 parent 671229d commit 32e4af7
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 2 deletions.
18 changes: 17 additions & 1 deletion docs/.vitepress/data/packageData.json
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,24 @@
}
]
},
"lucide-static": {
"lucide-astro": {
"order": 8,
"icon": "astro",
"shields": [
{
"alt": "npm",
"src": "https://img.shields.io/npm/v/lucide-astro",
"href": "https://www.npmjs.com/package/lucide-astro"
},
{
"alt": "npm",
"src": "https://img.shields.io/npm/dw/lucide-astro",
"href": "https://www.npmjs.com/package/lucide-astro"
}
]
},
"lucide-static": {
"order": 9,
"icon": "svg",
"shields": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ export default {
logo: '/framework-logos/angular.svg',
label: 'Lucide documentation for Angular',
},
{
name: 'lucide-astro',
logo: '/framework-logos/astro.svg',
label: 'Lucide documentation for Astro',
},
{
name: 'lucide-react-native',
logo: '/framework-logos/react-native.svg',
Expand Down
3 changes: 2 additions & 1 deletion docs/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ However, not everyone can understand them easily. Read more about [how to use Lu

## Official Packages

Lucide's official packages are designed to work on different platforms, making it easier for users to integrate icons into their projects. The packages are available for various technologies, including [Web (Vanilla)](https://lucide.dev/guide/packages/lucide), [React](https://lucide.dev/guide/packages/lucide-react), [React Native](https://lucide.dev/guide/packages/lucide-react-native), [Vue](https://lucide.dev/guide/packages/lucide-vue), [Vue 3](https://lucide.dev/guide/packages/lucide-vue-next), [Svelte](https://lucide.dev/guide/packages/lucide-svelte), [Preact](https://lucide.dev/guide/packages/lucide-preact), [Solid](https://lucide.dev/guide/packages/lucide-solid), [Angular](https://lucide.dev/guide/packages/lucide-angular), [NodeJS](https://lucide.dev/guide/packages/lucide-static#nodejs) and [Flutter](https://lucide.dev/guide/packages/lucide-flutter).
Lucide's official packages are designed to work on different platforms, making it easier for users to integrate icons into their projects. The packages are available for various technologies, including [Web (Vanilla)](https://lucide.dev/guide/packages/lucide), [React](https://lucide.dev/guide/packages/lucide-react), [React Native](https://lucide.dev/guide/packages/lucide-react-native), [Vue](https://lucide.dev/guide/packages/lucide-vue), [Vue 3](https://lucide.dev/guide/packages/lucide-vue-next), [Svelte](https://lucide.dev/guide/packages/lucide-svelte), [Preact](https://lucide.dev/guide/packages/lucide-preact), [Solid](https://lucide.dev/guide/packages/lucide-solid), [Angular](https://lucide.dev/guide/packages/lucide-angular), [Astro](https://lucide.dev/guide/packages/lucide-astro), [NodeJS](https://lucide.dev/guide/packages/lucide-static#nodejs) and [Flutter](https://lucide.dev/guide/packages/lucide-flutter).

## Community

If you have any questions about Lucide, feel free to reach out to the community. You can find them on [GitHub](https://github.com/lucide-icons/lucide) and [Discord](https://discord.gg/EH6nSts).
26 changes: 26 additions & 0 deletions docs/guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,32 @@ bun add lucide-preact

:::

## Astro

Implementation of the lucide icon library for Astro applications.

::: code-group

```sh [pnpm]
pnpm install lucide-astro
```

```sh [yarn]
yarn add lucide-astro
```

```sh [npm]
npm install lucide-astro
```

```sh [bun]
bun add lucide-astro
```

:::

For more details, see the [documentation](packages/lucide-astro.md).

## Static usage

Implementation of the lucide icon library for multiple usages that like to use: SVG files icons, SVG Sprite, Icon Fonts and static SVG strings export in Common JS modules (for NodeJS).
Expand Down
11 changes: 11 additions & 0 deletions docs/public/framework-logos/astro.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 32e4af7

Please sign in to comment.