Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@vue-email/compiler
Advanced tools
@vue-email/compiler - npm Package Compare versions
Comparing version 0.8.0-beta.3 to 0.8.0-beta.4
| { | ||
| "name": "@vue-email/compiler", | ||
| "version": "0.8.0-beta.3", | ||
| "version": "0.8.0-beta.4", | ||
| "description": "Compile vue-email templates", | ||
@@ -31,5 +31,5 @@ "author": "David Arenas <davejs136@gmail.com> (https://github.com/Dave136/)", | ||
| "import-string": "^0.1.0", | ||
| "@vue-email/types": "0.8.0-beta.3", | ||
| "@vue-email/core": "0.8.0-beta.3", | ||
| "@vue-email/utils": "0.8.0-beta.3" | ||
| "@vue-email/core": "0.8.0-beta.4", | ||
| "@vue-email/utils": "0.8.0-beta.4", | ||
| "@vue-email/types": "0.8.0-beta.4" | ||
| }, | ||
@@ -36,0 +36,0 @@ "scripts": { |
127
README.md
@@ -1,12 +0,127 @@ | ||
| # @vue-email/compiler | ||
| [](https://vuemail.net) | ||
| Compiler features for Vue Email | ||
| # 💌 vue-email | ||
| ## Documentation | ||
| [](https://www.npmjs.com/package/vue-email) | ||
| [](https://www.npmjs.com/package/vue-email) | ||
| [](https://github.com/Dave136/vue-email/blob/main/LICENSE) | ||
| [](https://www.vuemail.net/getting-started) | ||
| Please refer to the [documentation](https://www.vuemail.net/server-side-rendering/node-and-bun) | ||
| ## LICENSE | ||
| > Simple way to build email templates in vue. | ||
| License is under MIT | ||
| - [✨ Release Notes](https://github.com/Dave136/vue-email/releases) | ||
| - [📖 Read the documentation](https://vuemail.net) | ||
| - [💚 Nuxt Module](https://nuxt.com/modules/vue-email) | ||
| > [!IMPORTANT] | ||
| > Experimental and under heavy development. APIs are subject to change. | ||
| ## Features | ||
| - 🧩 Build email templates with Vue components | ||
| - 🛤️ [SSR support](https://vuemail.net/getting-started/ssr), preview/send emails both on server and client, now with support for [deno](https://deno.land/) and [bun](https://bun.sh/). | ||
| - 🌍 [i18n support](https://vuemail.net/getting-started/i18n) | ||
| - 📨 [Integrates with many email providers](https://vuemail.net/integrations/nodemailer) | ||
| - 🧪 Tested against popular email clients | ||
| - 🎨 [Supports Tailwind CSS](https://vuemail.net/components/tailwind) | ||
| - 🚚 First-class support for Nuxt 3 | ||
| - ✨ Written in TypeScript | ||
| ## Setup | ||
| > [📖 Read the documentation](https://vuemail.net) | ||
| ```bash | ||
| # pnpm | ||
| pnpm add -D vue-email | ||
| # npm | ||
| npm i -D vue-email | ||
| ``` | ||
| ## Basic Usage | ||
| > [📖 Read the documentation](https://vuemail.net) | ||
| ```html | ||
| // components/template-email.vue | ||
| <script setup> | ||
| import { EButton, EHr, EHtml, EText } from 'vue-email'; | ||
| import { ref } from 'vue'; | ||
| const user = ref('Dave'); | ||
| </script> | ||
| <template> | ||
| <e-html lang="en"> | ||
| <e-text>Hello, {{ user }}!</e-text> | ||
| <e-hr /> | ||
| <e-button href="vuejs.org">Visit vue</e-button> | ||
| </e-html> | ||
| </template> | ||
| ``` | ||
| > You can see the full example [here](https://github.com/Dave136/vue-email/getting-started/setup.html) | ||
| ## Advanced Usage - SSR | ||
| > [📖 Read the SSR documentation](https://vuemail.net/getting-started/ssr) | ||
| For SSR, you need to install `@vue-email/compiler`, now `compiler` with support for [deno](https://deno.land/), and [bun](https://bun.sh/). | ||
| ```js | ||
| import express from "express"; | ||
| import { config } from "@vue-email/compiler"; | ||
| const app = express(); | ||
| const vueEmail = config("./templates", { | ||
| verbose: false, | ||
| options: { | ||
| baseUrl: "https://vue-email-demo.vercel.app/", | ||
| }, | ||
| }); | ||
| app.get("/", async function (req, res) { | ||
| const template = await vueEmail.render("WelcomeEmail.vue", { | ||
| props: { | ||
| name: "John Doe", | ||
| }, | ||
| }); | ||
| res.send(template); | ||
| }); | ||
| app.listen(3000); | ||
| ``` | ||
| ## 💻 Development | ||
| 1. Clone this repository | ||
| 2. Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` | ||
| 3. Install dependencies using `pnpm install` | ||
| ## 🛟 Support | ||
| If you like our work, please feel to free to support us! | ||
| - BTC: `1Bwo1Htd47rLRM4PZhydWtoC5ZAR4Fv9KZ` | ||
| - USDT: [binance-qr](https://github.com/Dave136/vue-email/blob/main/docs/public/binance-qr.png?raw=true) | ||
| ## Contributors | ||
| <a href="https://github.com/Dave136/vue-email/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=Dave136/vue-email" /> | ||
| </a> | ||
| ## Repo Activity | ||
| <img width="100%" src="https://repobeats.axiom.co/api/embed/7b2dec4aa2ae80fa81831c28f9bb7cdc532960fa.svg" /> | ||
| ## 📝 Annotations | ||
| This project is inspired by [react-email](https://react.email/) | ||
| ## License | ||
| This project is licensed under [MIT](./LICENSE) |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.04%
500606
- Number of lines in readme file
- increased by884.62%
128
Dependency changes
+ Added@vue-email/core@0.8.0-beta.4(transitive)
+ Added@vue-email/types@0.8.0-beta.4(transitive)
+ Added@vue-email/utils@0.8.0-beta.4(transitive)
- Removed@vue-email/core@0.8.0-beta.3(transitive)
- Removed@vue-email/types@0.8.0-beta.3(transitive)
- Removed@vue-email/utils@0.8.0-beta.3(transitive)
Updated@vue-email/core@0.8.0-beta.4