|
1 | | -[](https://vuemail.net) |
| 1 | +we just merged a new project rewrite, please do check the docs and the updated logic https://vuemail.net/ |
2 | 2 |
|
3 | | -<div align="center"> |
4 | | - |
5 | | -[![npm version][npm-version-src]][npm-version-href] |
6 | | -[![npm downloads][npm-downloads-src]][npm-downloads-href] |
7 | | -[![JSDocs][jsdocs-src]][jsdocs-href] |
8 | | -[![License][license-src]][license-href] |
9 | | - |
10 | | -</div> |
11 | | - |
12 | | -# @vue-email/nuxt |
13 | | - |
14 | | -Official Nuxt module for Vue Email. Build email templates with Vue components. |
15 | | - |
16 | | -- [✨ Release Notes](https://github.com/vue-email/nuxt/releases) |
17 | | -- [📖 Documentation](https://vuemail.net/ssr/nuxt) |
18 | | - |
19 | | -## Features |
20 | | - |
21 | | -- Auto-import Vue Email components and composables |
22 | | -- `useCompiler` utility to render emails on the server |
23 | | -- All the DX Magic that comes with Nuxt ✨ |
24 | | -- Vue Email DevTools integration |
25 | | - |
26 | | -## Ecosystem |
27 | | - |
28 | | -| Package | Version | |
29 | | -| --------------------------- | :------------------------------------------------------------------------------------------------- | |
30 | | -| [Vue-Email](https://github.com/vue-email/vue-email) |  | |
31 | | -| [Nuxt](https://github.com/vue-email/nuxt) |  | |
32 | | -[SSR Compiler](https://github.com/vue-email/compiler) |  | |
33 | | -| [CLI](https://github.com/vue-email/cli) |  | |
34 | | - |
35 | | -## Quick Setup |
36 | | - |
37 | | -1. Add `@vue-email/nuxt` dependency to your project |
38 | | - |
39 | | -```bash |
40 | | -# Using pnpm |
41 | | -pnpm add -D @vue-email/nuxt |
42 | | - |
43 | | -# Using yarn |
44 | | -yarn add --dev @vue-email/nuxt |
45 | | - |
46 | | -# Using npm |
47 | | -npm install --save-dev @vue-email/nuxt |
48 | | -``` |
49 | | - |
50 | | -2. Add `@vue-email/nuxt` to the `modules` section of `nuxt.config.ts` |
51 | | - |
52 | | -```js |
53 | | -export default defineNuxtConfig({ |
54 | | - modules: [ |
55 | | - '@vue-email/nuxt' |
56 | | - ] |
57 | | -}) |
58 | | -``` |
59 | | - |
60 | | -That's it! You can now use My Module in your Nuxt app ✨ |
61 | | - |
62 | | -## Development |
63 | | - |
64 | | -```bash |
65 | | -# Install dependencies |
66 | | -npm install |
67 | | - |
68 | | -# Generate type stubs |
69 | | -npm run dev:prepare |
70 | | - |
71 | | -# Develop with the playground |
72 | | -npm run dev |
73 | | - |
74 | | -# Build the playground |
75 | | -npm run dev:build |
76 | | - |
77 | | -# Run ESLint |
78 | | -npm run lint |
79 | | - |
80 | | -# Run Vitest |
81 | | -npm run test |
82 | | -npm run test:watch |
83 | | - |
84 | | -# Release new version |
85 | | -npm run release |
86 | | -``` |
87 | | - |
88 | | -## License |
89 | | - |
90 | | -[MIT](./LICENSE) License © 2023-PRESENT [Vue Email](https://vuemail.net/) |
91 | | - |
92 | | -<!-- Badges --> |
93 | | -[npm-version-src]: https://img.shields.io/npm/v/@vue-email/nuxt/latest.svg?style=flat&colorA=18181B&colorB=28CF8D |
94 | | -[npm-version-href]: https://npmjs.com/package/@vue-email/nuxt |
95 | | - |
96 | | -[npm-downloads-src]: https://img.shields.io/npm/dm/@vue-email/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D |
97 | | -[npm-downloads-href]: https://npmjs.com/package/@vue-email/nuxt |
98 | | - |
99 | | -[license-src]: https://img.shields.io/npm/l/@vue-email/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D |
100 | | -[license-href]: https://npmjs.com/package/@vue-email/nuxt |
101 | | - |
102 | | -[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669 |
103 | | -[jsdocs-href]: https://www.jsdocs.io/package/@vue-email/nuxt |
| 3 | +Currently there's no need for a nuxt module, as we are not adding anything specific to nuxt. |
0 commit comments