https://github.com/barelyhuman/nuxt-module-preact-islands
https://github.com/barelyhuman/nuxt-module-preact-islands
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/barelyhuman/nuxt-module-preact-islands
- Owner: barelyhuman
- Created: 2023-07-03T17:43:27.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-16T18:19:35.000Z (over 1 year ago)
- Last Synced: 2025-04-15T02:12:33.288Z (2 months ago)
- Language: TypeScript
- Size: 177 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nuxt-module-preact-islands
Simple nuxt module wrapper around preact-island-plugins
- [✨ Release Notes](/CHANGELOG.md)
# NOT YET RELEASED!
## Quick Setup
1. Add `nuxt-module-preact-islands` dependency to your project
```bash
# Using pnpm
pnpm add -D nuxt-module-preact-islands tslib
pnpm add preact preact-render-to-string
# Using yarn
yarn add --dev nuxt-module-preact-islands tslib
yarn add preact preact-render-to-string
# Using npm
npm install --save-dev nuxt-module-preact-islands tslib
npm add preact preact-render-to-string
```
2. Add `nuxt-module-preact-islands` to the `modules` section of `nuxt.config.ts`
```js
export default defineNuxtConfig({
modules: [
'nuxt-module-preact-islands'
]
})
```
That's it! You can now use nuxt-module-preact-islands in your Nuxt app ✨
## Development
```bash
# Install dependencies
npm install
# Generate type stubs
npm run dev:prepare
# Develop with the playground
npm run dev
# Build the playground
npm run dev:build
# Run ESLint
npm run lint
# Run Vitest
npm run test
npm run test:watch
# Release new version
npm run release
```
[npm-version-src]: https://img.shields.io/npm/v/nuxt-module-preact-islands/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/nuxt-module-preact-islands
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-module-preact-islands.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/nuxt-module-preact-islands
[license-src]: https://img.shields.io/npm/l/nuxt-module-preact-islands.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/nuxt-module-preact-islands
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com