Skip to content

Commit

Permalink
feat(init): ✨ initialization
Browse files Browse the repository at this point in the history
  • Loading branch information
waset committed Oct 17, 2024
1 parent 9506511 commit 22a064a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 126 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 Anthony Fu <https://github.com/antfu>
Copyright (c) 2021 Waset <https://github.com/waset>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
126 changes: 1 addition & 125 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,132 +4,8 @@

Iconify template for [unplugin](https://github.com/unjs/unplugin).

## Template Usage

To use this template, clone it down using:

```bash
npx degit unplugin/unplugin-iconify my-unplugin
```

And do a global replacement of `unplugin-iconify` with your plugin name.

Then you can start developing your unplugin 🔥

To test your plugin, run: `pnpm run dev`
To release a new version, run: `pnpm run release`

## Install

```bash
npm i unplugin-iconify
npm i -D unplugin-iconify
```

<details>
<summary>Vite</summary><br>

```ts
// vite.config.ts
import Iconify from 'unplugin-iconify/vite'

export default defineConfig({
plugins: [
Iconify({
/* options */
}),
],
})
```

Example: [`playground/`](./playground/)

<br></details>

<details>
<summary>Rollup</summary><br>

```ts
// rollup.config.js
import Iconify from 'unplugin-iconify/rollup'

export default {
plugins: [
Iconify({
/* options */
}),
],
}
```

<br></details>

<details>
<summary>Webpack</summary><br>

```ts
// webpack.config.js
module.exports = {
/* ... */
plugins: [
require('unplugin-iconify/webpack')({
/* options */
}),
],
}
```

<br></details>

<details>
<summary>Nuxt</summary><br>

```ts
// nuxt.config.js
export default defineNuxtConfig({
modules: [
[
'unplugin-iconify/nuxt',
{
/* options */
},
],
],
})
```

> This module works for both Nuxt 2 and [Nuxt Vite](https://github.com/nuxt/vite)
<br></details>

<details>
<summary>Vue CLI</summary><br>

```ts
// vue.config.js
module.exports = {
configureWebpack: {
plugins: [
require('unplugin-iconify/webpack')({
/* options */
}),
],
},
}
```

<br></details>

<details>
<summary>esbuild</summary><br>

```ts
// esbuild.config.js
import { build } from 'esbuild'
import Iconify from 'unplugin-iconify/esbuild'

build({
plugins: [Iconify()],
})
```

<br></details>

0 comments on commit 22a064a

Please sign in to comment.