From 4f038d5fe8b13e00031311af6975a43d2d735e9e Mon Sep 17 00:00:00 2001 From: Sunshio Date: Fri, 29 Nov 2024 09:11:30 +0100 Subject: [PATCH] feat(docs): add Bun.sh support to documentation (#2642) --- CONTRIBUTING.md | 2 +- docs/guide/installation.md | 32 ++++++++++++++++++++++ docs/guide/packages/lucide-angular.md | 4 +++ docs/guide/packages/lucide-preact.md | 4 +++ docs/guide/packages/lucide-react-native.md | 4 +++ docs/guide/packages/lucide-react.md | 4 +++ docs/guide/packages/lucide-solid.md | 4 +++ docs/guide/packages/lucide-static.md | 4 +++ docs/guide/packages/lucide-svelte.md | 4 +++ docs/guide/packages/lucide-vue-next.md | 4 +++ docs/guide/packages/lucide-vue.md | 4 +++ docs/guide/packages/lucide.md | 4 +++ packages/lucide-angular/README.md | 4 +++ packages/lucide-preact/README.md | 4 +++ packages/lucide-react-native/README.md | 4 +++ packages/lucide-react/README.md | 4 +++ packages/lucide-solid/README.md | 4 +++ packages/lucide-static/README.md | 4 +++ packages/lucide-svelte/README.md | 4 +++ packages/lucide-vue-next/README.md | 4 +++ packages/lucide-vue/README.md | 4 +++ packages/lucide/README.md | 4 +++ 22 files changed, 113 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ebce76e4134..d2902957f55 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -127,7 +127,7 @@ When adding new features to for example the icon component for a framework. It i ### Local Testing -To test changes in a local project, you can use `yarn link`, `npm link` or `pnpm link` to link the package. Before you do this make sure you builded the package first. +To test changes in a local project, you can use `yarn link`, `npm link`, `bun link` or `pnpm link` to link the package. Before you do this make sure you builded the package first. ```sh # in packages/lucide-react diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 018e5cf8499..27e6d5b6518 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -22,6 +22,10 @@ yarn add lucide npm install lucide ``` +```sh [bun] +bun add lucide +``` + ::: For more details, see the [documentation](packages/lucide.md). @@ -44,6 +48,10 @@ yarn add lucide-react npm install lucide-react ``` +```sh [bun] +bun add lucide-react +``` + ::: For more details, see the [documentation](packages/lucide-react.md). @@ -67,6 +75,10 @@ yarn add lucide-vue-next npm install lucide-vue-next ``` +```sh [bun] +bun add lucide-vue-next +``` + ::: For more details, see the [documentation](packages/lucide-vue-next.md). @@ -90,6 +102,10 @@ yarn add lucide-svelte npm install lucide-svelte ``` +```sh [bun] +bun add lucide-svelte +``` + ::: For more details, see the [documentation](packages/lucide-svelte.md). @@ -112,6 +128,10 @@ yarn add lucide-solid npm install lucide-solid ``` +```sh [bun] +bun add lucide-solid +``` + ::: For more details, see the [documentation](packages/lucide-solid.md). @@ -134,6 +154,10 @@ yarn add lucide-angular npm install lucide-angular ``` +```sh [bun] +bun add lucide-angular +``` + ::: For more details, see the [documentation](packages/lucide-angular.md). @@ -156,6 +180,10 @@ yarn add lucide-preact npm install lucide-preact ``` +```sh [bun] +bun add lucide-preact +``` + ::: ## Static usage @@ -176,6 +204,10 @@ yarn add lucide-static npm install lucide-static ``` +```sh [bun] +bun add lucide-static +``` + ::: For more details, see the [documentation](packages/lucide-static.md). diff --git a/docs/guide/packages/lucide-angular.md b/docs/guide/packages/lucide-angular.md index 403e9fd5e18..1b1d4c776f8 100644 --- a/docs/guide/packages/lucide-angular.md +++ b/docs/guide/packages/lucide-angular.md @@ -18,6 +18,10 @@ yarn add lucide-angular npm install lucide-angular ``` +```sh [bun] +bun add lucide-angular +``` + ::: ## How to use diff --git a/docs/guide/packages/lucide-preact.md b/docs/guide/packages/lucide-preact.md index 7ebb879e2c8..ea5d54a917c 100644 --- a/docs/guide/packages/lucide-preact.md +++ b/docs/guide/packages/lucide-preact.md @@ -22,6 +22,10 @@ yarn add lucide-preact npm install lucide-preact ``` +```sh [bun] +bun add lucide-preact +``` + ::: ## How to use diff --git a/docs/guide/packages/lucide-react-native.md b/docs/guide/packages/lucide-react-native.md index c5dacbe00df..b3a5d8e8080 100644 --- a/docs/guide/packages/lucide-react-native.md +++ b/docs/guide/packages/lucide-react-native.md @@ -20,6 +20,10 @@ yarn add lucide-react-native npm install lucide-react-native ``` +```sh [bun] +bun add lucide-react-native +``` + ::: ## How to use diff --git a/docs/guide/packages/lucide-react.md b/docs/guide/packages/lucide-react.md index 4c8a0c303a3..4f5ca75b0e5 100644 --- a/docs/guide/packages/lucide-react.md +++ b/docs/guide/packages/lucide-react.md @@ -18,6 +18,10 @@ yarn add lucide-react npm install lucide-react ``` +```sh [bun] +bun add lucide-react +``` + ::: ## How to use diff --git a/docs/guide/packages/lucide-solid.md b/docs/guide/packages/lucide-solid.md index ae2dd8bb299..16a59250409 100644 --- a/docs/guide/packages/lucide-solid.md +++ b/docs/guide/packages/lucide-solid.md @@ -18,6 +18,10 @@ yarn add lucide-solid npm install lucide-solid ``` +```sh [bun] +bun add lucide-solid +``` + ::: ## How to use diff --git a/docs/guide/packages/lucide-static.md b/docs/guide/packages/lucide-static.md index 139ff90ce0c..3f2844b41fc 100644 --- a/docs/guide/packages/lucide-static.md +++ b/docs/guide/packages/lucide-static.md @@ -33,6 +33,10 @@ yarn add lucide-static npm install lucide-static ``` +```sh [bun] +bun add lucide-static +``` + ::: ### CDN diff --git a/docs/guide/packages/lucide-svelte.md b/docs/guide/packages/lucide-svelte.md index 77877ea2039..d546496b3ce 100644 --- a/docs/guide/packages/lucide-svelte.md +++ b/docs/guide/packages/lucide-svelte.md @@ -18,6 +18,10 @@ yarn add lucide-svelte npm install lucide-svelte ``` +```sh [bun] +bun add lucide-svelte +``` + ::: ## How to use diff --git a/docs/guide/packages/lucide-vue-next.md b/docs/guide/packages/lucide-vue-next.md index 99daae2f5d3..b34465b5d67 100644 --- a/docs/guide/packages/lucide-vue-next.md +++ b/docs/guide/packages/lucide-vue-next.md @@ -18,6 +18,10 @@ yarn add lucide-vue-next npm install lucide-vue-next ``` +```sh [bun] +bun add lucide-vue-next +``` + ::: ## How to use diff --git a/docs/guide/packages/lucide-vue.md b/docs/guide/packages/lucide-vue.md index 2d8ea2e5427..28b8b172977 100644 --- a/docs/guide/packages/lucide-vue.md +++ b/docs/guide/packages/lucide-vue.md @@ -22,6 +22,10 @@ yarn add lucide-vue npm install lucide-vue ``` +```sh [bun] +bun add lucide-vue +``` + ::: ## How to use diff --git a/docs/guide/packages/lucide.md b/docs/guide/packages/lucide.md index c42b228ac97..813d143a5b1 100644 --- a/docs/guide/packages/lucide.md +++ b/docs/guide/packages/lucide.md @@ -20,6 +20,10 @@ yarn add lucide npm install lucide ``` +```sh [bun] +bun add lucide +``` + ::: ### CDN diff --git a/packages/lucide-angular/README.md b/packages/lucide-angular/README.md index 7861ae674cc..729588e2d0a 100644 --- a/packages/lucide-angular/README.md +++ b/packages/lucide-angular/README.md @@ -43,6 +43,10 @@ npm install lucide-angular yarn add lucide-angular ``` +```sh +bun add lucide-angular +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-angular) diff --git a/packages/lucide-preact/README.md b/packages/lucide-preact/README.md index 6fbdd4f76b7..0bca38c2793 100644 --- a/packages/lucide-preact/README.md +++ b/packages/lucide-preact/README.md @@ -43,6 +43,10 @@ npm install lucide-preact yarn add lucide-preact ``` +```sh +bun add lucide-preact +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-preact) diff --git a/packages/lucide-react-native/README.md b/packages/lucide-react-native/README.md index 2004b0b99b6..eef0a6322c2 100644 --- a/packages/lucide-react-native/README.md +++ b/packages/lucide-react-native/README.md @@ -43,6 +43,10 @@ npm install lucide-react-native yarn add lucide-react-native ``` +```sh +bun add lucide-react-native +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-react-native) diff --git a/packages/lucide-react/README.md b/packages/lucide-react/README.md index 5f50784caec..8d02efe9683 100644 --- a/packages/lucide-react/README.md +++ b/packages/lucide-react/README.md @@ -43,6 +43,10 @@ npm install lucide-react yarn add lucide-react ``` +```sh +bun add lucide-react +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-react) diff --git a/packages/lucide-solid/README.md b/packages/lucide-solid/README.md index cf8cc7bbbf0..0c9a8a62f4e 100644 --- a/packages/lucide-solid/README.md +++ b/packages/lucide-solid/README.md @@ -43,6 +43,10 @@ npm install lucide-solid yarn add lucide-solid ``` +```sh +bun add lucide-solid +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-solid) diff --git a/packages/lucide-static/README.md b/packages/lucide-static/README.md index b112197e379..41f3434d2fe 100644 --- a/packages/lucide-static/README.md +++ b/packages/lucide-static/README.md @@ -57,6 +57,10 @@ npm install lucide-static yarn add lucide-static ``` +```sh +bun add lucide-static +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-static) diff --git a/packages/lucide-svelte/README.md b/packages/lucide-svelte/README.md index f295d985622..6ca96ea77a3 100644 --- a/packages/lucide-svelte/README.md +++ b/packages/lucide-svelte/README.md @@ -43,6 +43,10 @@ npm install lucide-svelte yarn add lucide-svelte ``` +```sh +bun add lucide-svelte +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-svelte) diff --git a/packages/lucide-vue-next/README.md b/packages/lucide-vue-next/README.md index 95b7962bb93..ad4c3e7ed61 100644 --- a/packages/lucide-vue-next/README.md +++ b/packages/lucide-vue-next/README.md @@ -43,6 +43,10 @@ npm install lucide-vue-next yarn add lucide-vue-next ``` +```sh +bun add lucide-vue-next +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-vue-next) diff --git a/packages/lucide-vue/README.md b/packages/lucide-vue/README.md index 5ea6beb6fde..447029d1593 100644 --- a/packages/lucide-vue/README.md +++ b/packages/lucide-vue/README.md @@ -47,6 +47,10 @@ npm install lucide-vue yarn add lucide-vue ``` +```sh +bun add lucide-vue +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-vue) diff --git a/packages/lucide/README.md b/packages/lucide/README.md index d9079c40c77..d034cd2c160 100644 --- a/packages/lucide/README.md +++ b/packages/lucide/README.md @@ -43,6 +43,10 @@ npm install lucide yarn add lucide ``` +```sh +bun add lucide +``` + ### CDN ```html