Skip to content

Commit

Permalink
feat(docs): add Bun.sh support to documentation (#2642)
Browse files Browse the repository at this point in the history
  • Loading branch information
Pietrucci-Blacher authored Nov 29, 2024
1 parent 5ca6bc3 commit 4f038d5
Show file tree
Hide file tree
Showing 22 changed files with 113 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
32 changes: 32 additions & 0 deletions docs/guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ yarn add lucide
npm install lucide
```

```sh [bun]
bun add lucide
```

:::

For more details, see the [documentation](packages/lucide.md).
Expand All @@ -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).
Expand All @@ -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).
Expand All @@ -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).
Expand All @@ -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).
Expand All @@ -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).
Expand All @@ -156,6 +180,10 @@ yarn add lucide-preact
npm install lucide-preact
```

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

:::

## Static usage
Expand All @@ -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).
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/packages/lucide-angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ yarn add lucide-angular
npm install lucide-angular
```

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

:::

## How to use
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/packages/lucide-preact.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ yarn add lucide-preact
npm install lucide-preact
```

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

:::

## How to use
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/packages/lucide-react-native.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ yarn add lucide-react-native
npm install lucide-react-native
```

```sh [bun]
bun add lucide-react-native
```

:::

## How to use
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/packages/lucide-react.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ yarn add lucide-react
npm install lucide-react
```

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

:::

## How to use
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/packages/lucide-solid.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ yarn add lucide-solid
npm install lucide-solid
```

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

:::

## How to use
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/packages/lucide-static.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ yarn add lucide-static
npm install lucide-static
```

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

:::

### CDN
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/packages/lucide-svelte.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ yarn add lucide-svelte
npm install lucide-svelte
```

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

:::

## How to use
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/packages/lucide-vue-next.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ yarn add lucide-vue-next
npm install lucide-vue-next
```

```sh [bun]
bun add lucide-vue-next
```

:::

## How to use
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/packages/lucide-vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ yarn add lucide-vue
npm install lucide-vue
```

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

:::

## How to use
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/packages/lucide.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ yarn add lucide
npm install lucide
```

```sh [bun]
bun add lucide
```

:::

### CDN
Expand Down
4 changes: 4 additions & 0 deletions packages/lucide-angular/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions packages/lucide-preact/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions packages/lucide-react-native/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions packages/lucide-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions packages/lucide-solid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions packages/lucide-static/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions packages/lucide-svelte/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions packages/lucide-vue-next/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions packages/lucide-vue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions packages/lucide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ npm install lucide
yarn add lucide
```

```sh
bun add lucide
```

### CDN

```html
Expand Down

0 comments on commit 4f038d5

Please sign in to comment.