### Copy Environment File (bash)
Source: https://github.com/vue-email/docs/blob/main/README.md
Copies the example environment file to a new file named .env. This is typically done during the initial setup to configure project variables.
```bash
cp .env.example .env
```
--------------------------------
### Install Vue Email Packages
Source: https://context7.com/vue-email/docs/llms.txt
Installs the necessary Vue Email packages, including render utilities and UI components, using pnpm. Users can install all packages at once or specific ones as needed.
```bash
# Install both render utilities and components
pnpm add @vue-email/render @vue-email/components
# Or install individually
pnpm add @vue-email/button
pnpm add @vue-email/html
pnpm add @vue-email/text
```
--------------------------------
### Install Preview Component using Package Managers
Source: https://github.com/vue-email/docs/blob/main/content/2.components/16.preview.md
Instructions for installing the '@vue-email/components' package or the individual '@vue-email/preview' package using pnpm, yarn, and npm. These commands add the necessary components to your project.
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/preview
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/preview
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/preview
```
--------------------------------
### Install Dependencies (bash)
Source: https://github.com/vue-email/docs/blob/main/README.md
Installs the necessary project dependencies using pnpm. This command should be run after cloning the repository.
```bash
pnpm install
```
--------------------------------
### Start Development Server (bash)
Source: https://github.com/vue-email/docs/blob/main/README.md
Starts the development server for the Vue Email project, allowing for live preview and hot-reloading during development. Uses npm.
```bash
npm run dev
```
--------------------------------
### Install @vue-email/text Component
Source: https://github.com/vue-email/docs/blob/main/content/2.components/19.text.md
Installs the Text component from the @vue-email/components package or as an individual package. Supports pnpm, yarn, and npm package managers.
```pnpm
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/text
```
```yarn
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/text
```
```npm
npm install @vue-email/components
# or get the individual package
npm install @vue-email/text
```
--------------------------------
### Install @vue-email/style Package
Source: https://github.com/vue-email/docs/blob/main/content/2.components/3.style.md
Instructions for installing the @vue-email/style package using various package managers (pnpm, yarn, npm). You can install the entire @vue-email/components package or just the individual style package.
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/style
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/style
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/style
```
--------------------------------
### Install @vue-email/components or @vue-email/section
Source: https://github.com/vue-email/docs/blob/main/content/2.components/17.section.md
Installs the @vue-email/components package or the individual @vue-email/section package using pnpm, yarn, or npm.
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/section
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/section
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/section
```
--------------------------------
### Install @vue-email/components or @vue-email/container
Source: https://github.com/vue-email/docs/blob/main/content/2.components/5.container.md
Installs the necessary @vue-email/components package or the individual @vue-email/container package using package managers like pnpm, yarn, or npm. Ensure you have Node.js and a package manager installed.
```pnpm
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/container
```
```yarn
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/container
```
```npm
npm install @vue-email/components
# or get the individual package
npm install @vue-email/container
```
--------------------------------
### Install Row Component (Package Managers)
Source: https://github.com/vue-email/docs/blob/main/content/2.components/9.row.md
Instructions for installing the @vue-email/row package or the full @vue-email/components package using pnpm, yarn, and npm.
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/row
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/row
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/row
```
--------------------------------
### Install @vue-email/code-block Component
Source: https://github.com/vue-email/docs/blob/main/content/2.components/6.code-block.md
Demonstrates how to install the @vue-email/code-block package using different package managers like pnpm, yarn, and npm. This component is part of the @vue-email/components library or can be installed individually.
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/code-block
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/code-block
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/code-block
```
--------------------------------
### Install Vue Email Heading Component
Source: https://github.com/vue-email/docs/blob/main/content/2.components/11.heading.md
Instructions for installing the '@vue-email/components' package or the individual '@vue-email/heading' package using different package managers like pnpm, yarn, and npm.
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/heading
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/heading
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/heading
```
--------------------------------
### Install Markdown Component (pnpm, yarn, npm)
Source: https://github.com/vue-email/docs/blob/main/content/2.components/15.markdown.md
Install the Markdown component and its dependencies using your preferred package manager (pnpm, yarn, or npm). You can install the entire '@vue-email/components' package or the individual '@vue-email/markdown' package.
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/markdown
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/markdown
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/markdown
```
--------------------------------
### Install Column Component with Package Managers
Source: https://github.com/vue-email/docs/blob/main/content/2.components/8.column.md
Instructions for installing the Column component, either as part of the main @vue-email/components package or as an individual package, using pnpm, yarn, and npm.
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/column
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/column
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/column
```
--------------------------------
### Use Vue Email Heading Component in Template
Source: https://github.com/vue-email/docs/blob/main/content/2.components/11.heading.md
A basic example demonstrating how to import and use the Heading component within a Vue.js template. It shows the necessary script setup and template structure.
```vue
Lorem ipsum
```
--------------------------------
### Install @vue-email/code-inline Component
Source: https://github.com/vue-email/docs/blob/main/content/2.components/7.code-inline.md
Instructions for installing the @vue-email/code-inline package using different package managers (pnpm, yarn, npm). This component is part of the @vue-email/components library.
```pnpm
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/code-inline
```
```yarn
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/code-inline
```
```npm
npm install @vue-email/components
# or get the individual package
npm install @vue-email/code-inline
```
--------------------------------
### Install Button Component (pnpm, yarn, npm)
Source: https://github.com/vue-email/docs/blob/main/content/2.components/4.button.md
Installs the Vue Email Button component using package managers. You can install the entire components package or just the individual button package.
```pnpm
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/button
```
```yarn
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/button
```
```npm
npm install @vue-email/components
# or get the individual package
npm install @vue-email/button
```
--------------------------------
### Install Vue Email Font Component
Source: https://github.com/vue-email/docs/blob/main/content/2.components/10.font.md
Instructions for installing the @vue-email/font package or the entire @vue-email/components package using different package managers (pnpm, yarn, npm).
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/font
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/font
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/font
```
--------------------------------
### Vue Email Html Component Example
Source: https://context7.com/vue-email/docs/llms.txt
Demonstrates the root Html component for email templates, supporting language and direction attributes. It wraps content like Text and Button components.
```vue
{{ message }}
```
--------------------------------
### Install @vue-email/components and @vue-email/tailwind
Source: https://github.com/vue-email/docs/blob/main/content/2.components/1.tailwind.md
Install the necessary packages for Vue Email components and Tailwind CSS integration using your preferred package manager (pnpm, yarn, or npm).
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/tailwind
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/tailwind
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/tailwind
```
--------------------------------
### Install Image Component - Package Managers
Source: https://github.com/vue-email/docs/blob/main/content/2.components/13.image.md
Install the @vue-email/components package or the individual @vue-email/img package using your preferred package manager (pnpm, yarn, or npm).
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/img
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/img
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/img
```
--------------------------------
### Basic Usage of Hr Component in Vue Template
Source: https://github.com/vue-email/docs/blob/main/content/2.components/12.hr.md
Import and use the Hr component within your Vue email template. This example demonstrates a simple setup where the Hr component is directly included in the template to render a horizontal rule.
```vue
```
--------------------------------
### Install @vue-email/head and @vue-email/components
Source: https://github.com/vue-email/docs/blob/main/content/2.components/2.head.md
Install the @vue-email/head and @vue-email/components packages using your preferred package manager (pnpm, yarn, or npm). This allows you to use the Head component in your Vue email templates.
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/head
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/head
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/head
```
--------------------------------
### Vue Email Text Component Example
Source: https://context7.com/vue-email/docs/llms.txt
Illustrates the Text component for standard text blocks, ensuring proper email spacing. It allows for custom styling and can be used for primary or secondary text content.
```vue
{{ content }}
This is a secondary text block with custom styling.
```
--------------------------------
### Vue Email Container Component Example
Source: https://context7.com/vue-email/docs/llms.txt
Demonstrates the Container component for centering email content with a consistent width. It's useful for structuring the main layout and can contain other elements like Text and Button.
```vue
Your content is now centered with proper email margins.
```
--------------------------------
### Install Vue Email Link Component
Source: https://github.com/vue-email/docs/blob/main/content/2.components/14.link.md
Installs the @vue-email/components package or the individual @vue-email/link package using different package managers like pnpm, yarn, and npm.
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/link
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/link
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/link
```
--------------------------------
### Install Vue Email HTML Component using package managers
Source: https://github.com/vue-email/docs/blob/main/content/2.components/1.html.md
Install the @vue-email/components or @vue-email/html package using your preferred package manager (pnpm, yarn, or npm). This component is essential for structuring email content within a Vue application.
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/html
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/html
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/html
```
--------------------------------
### Install Vite Vue Plugin for Nuxt/Nitro
Source: https://github.com/vue-email/docs/blob/main/content/1.getting-started/4.nuxt-nitro.md
Installs the necessary Vite Vue plugin for Nuxt and Nitro projects. This plugin enables the server-side processing of .vue files, which is crucial for email rendering in these frameworks. It is compatible with popular package managers like pnpm, yarn, and npm.
```sh
pnpm add @vitejs/plugin-vue
```
```bash
yarn add @vitejs/plugin-vue
```
```bash
npm install @vitejs/plugin-vue
```
--------------------------------
### Install Hr Component using Package Managers
Source: https://github.com/vue-email/docs/blob/main/content/2.components/12.hr.md
Install the Hr component as part of the '@vue-email/components' package or individually using pnpm, yarn, or npm. This provides the necessary module for using the Hr component in your Vue email templates.
```sh
pnpm add @vue-email/components
# or get the individual package
pnpm add @vue-email/hr
```
```bash
yarn add @vue-email/components
# or get the individual package
yarn add @vue-email/hr
```
```bash
npm install @vue-email/components
# or get the individual package
npm install @vue-email/hr
```
--------------------------------
### Usage Example - Vue Template
Source: https://github.com/vue-email/docs/blob/main/content/2.components/13.image.md
Add the Img component to your Vue email template. This example demonstrates importing the component and using it with src, alt, width, and height attributes. Supported image formats are png, gif, and jpg; avoid svg.
```vue
```
--------------------------------
### Vue Font Component Usage Example
Source: https://github.com/vue-email/docs/blob/main/content/2.components/10.font.md
A Vue.js template demonstrating how to use the Font component within an email template. It highlights the importance of fallbackFontFamily for email client compatibility and shows how to specify web font details like URL and format.
```vue
```
--------------------------------
### Vue Email HTML Component Usage Example
Source: https://github.com/vue-email/docs/blob/main/content/2.components/1.html.md
Demonstrates how to integrate the Vue Email HTML component into a Vue template. It shows importing necessary components and using the Html component to wrap other elements like Button, specifying language and direction attributes.
```vue
```
--------------------------------
### Complete Email Template Example in Vue
Source: https://context7.com/vue-email/docs/llms.txt
This Vue.js component demonstrates a full-featured transactional email template, including sections for order details, item listings, tracking information, and company branding. It utilizes various components from '@vue-email/components' for structured email content.
```vue
Your order #{{ orderNumber }} has been shipped
```
--------------------------------
### Add Horizontal Dividers with Vue Email Hr Component
Source: https://context7.com/vue-email/docs/llms.txt
The Hr component creates a horizontal rule, commonly used as a divider between sections in an email. It accepts inline styles to customize its appearance, such as border color and margins.
```vue
Section One ContentSection Two ContentSection Three Content
```
=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.