### Getting Started with JSX Email Source: https://github.com/shellscape/jsx-email/blob/main/packages/jsx-email/README.md This section guides users on how to get started with JSX email, directing them to the official documentation site for comprehensive information on components, props, and usage. ```markdown Everything to know about the components, props, and usage is available within our [Documentation Site](https://jsx.email/docs/introduction). Please give that a read and let us know if there's anything we can help with. ``` -------------------------------- ### Install Dependencies and Start Server Source: https://github.com/shellscape/jsx-email/blob/main/packages/create-jsx-email/README.md Commands to navigate into the newly created project directory, install its dependencies using pnpm, and start the development server for previewing email templates. ```sh cd email-project pnpm install pnpm run dev ``` -------------------------------- ### Getting Started with JSX Email Source: https://github.com/shellscape/jsx-email/blob/main/README.md This section guides users on how to get started with JSX email, directing them to the official documentation site for comprehensive information on components, props, and usage. ```markdown Everything to know about the components, props, and usage is available within our [Documentation Site](https://jsx.email/docs/introduction). Please give that a read and let us know if there's anything we can help with. ``` -------------------------------- ### Getting Started with JSX Email Source: https://github.com/shellscape/jsx-email/blob/main/apps/web/src/include/README.md This section guides users on how to get started with JSX email, directing them to the official documentation site for comprehensive information on components, props, and usage. ```markdown Everything to know about the components, props, and usage is available within our [Documentation Site](https://jsx.email/docs/introduction). Please give that a read and let us know if there's anything we can help with. ``` -------------------------------- ### Create New Project with create-jsx-email Source: https://github.com/shellscape/jsx-email/blob/main/docs/quick-start.md Scaffolds a new project for email templates using the `create-jsx-email` utility. This is the fastest way to get started with a new project dedicated to email templates or one that will include additional code. ```console $ npm create jsx-email ``` -------------------------------- ### Start Preview Server Source: https://github.com/shellscape/jsx-email/blob/main/apps/demo/README.md Starts the live-preview server for the demo application. This command is used to test email templates in a real-time environment. ```console $ moon run demo:dev ``` -------------------------------- ### Add JSX Email to Existing Projects Source: https://github.com/shellscape/jsx-email/blob/main/docs/quick-start.md Demonstrates how to add JSX Email to an existing project using the CLI. It shows the recommended way to use the `email` command, and alternatives like `pnpm dlx`, `npx`, or `yarn` for avoiding global installations. ```shell $ pnpm dlx email ``` -------------------------------- ### Run Email Preview Server Source: https://github.com/shellscape/jsx-email/blob/main/docs/quick-start.md Starts a local preview server for email templates. This server allows for quick iteration and viewing of email designs. It automatically opens a browser tab at `http://localhost:55420`. ```shell # MacOS and Linux $ email preview ./emails ``` -------------------------------- ### Install Dependencies Source: https://github.com/shellscape/jsx-email/blob/main/apps/web/src/include/CONTRIBUTING.md Command to install project dependencies using pnpm. Moon's caching ensures dependencies are up-to-date. ```console pnpm install ``` -------------------------------- ### Install Dependencies Source: https://github.com/shellscape/jsx-email/blob/main/CONTRIBUTING.md Command to install project dependencies using pnpm. Moon's caching ensures dependencies are up-to-date. ```console pnpm install ``` -------------------------------- ### Preview Command Example Source: https://github.com/shellscape/jsx-email/blob/main/docs/core/cli.md Demonstrates how to use the `preview` command to launch the built-in Preview Tool for viewing email templates. ```console $ cd ~/code/email-app $ email preview ./emails ``` -------------------------------- ### Install and Run Recipe Source: https://github.com/shellscape/jsx-email/blob/main/recipes/import-css/README.md This command installs the necessary dependencies and runs the development server for the jsx-email recipe. It's used to preview the 'Import CSS' template. ```shell $ npm i && npm run dev ``` -------------------------------- ### Check Command Output Example Source: https://github.com/shellscape/jsx-email/blob/main/docs/core/cli.md Provides an example of the output generated by the `check` command, highlighting potential email client incompatibility issues found in a template. ```console Checking email template for Client Compatibility... Found 1 files: ./emails/Batman.tsx Starting build... Build complete ./emails/Batman.tsx error Class selector is not supported by: gmail.mobile-webmail protonmail.desktop-webmail protonmail.ios error border-radius is not supported by: outlook.windows outlook.windows-mail ... warn target attribute is only partially supported by: apple-mail.macos apple-mail.ios outlook.windows outlook.windows-mail outlook.ios outlook.android Check Complete: 14 error(s), 20 warning(s) ``` -------------------------------- ### Build Command Example Source: https://github.com/shellscape/jsx-email/blob/main/docs/core/cli.md Shows how to use the `build` command to compile and render an email template to HTML. It accepts either a directory or a single file path as input. ```console $ cd ~/code/email-app $ email build ./emails ``` ```console $ cd ~/code/email-app $ email build ./emails/Batman.tsx ``` -------------------------------- ### Bootstrap Environment Source: https://github.com/shellscape/jsx-email/blob/main/CONTRIBUTING.md Initial script to run for setting up the development environment and installing all necessary dependencies. ```bash ./shared/bootstrap.sh ``` -------------------------------- ### Build Email Template to HTML Source: https://github.com/shellscape/jsx-email/blob/main/docs/quick-start.md Compiles a JSX email template into a static HTML document. This command can also accept props for dynamic rendering, and allows specifying output paths and other options via flags. ```shell $ email build ./emails/BatmanEmail.tsx ``` -------------------------------- ### Bootstrap Environment Source: https://github.com/shellscape/jsx-email/blob/main/apps/web/src/include/CONTRIBUTING.md Initial script to run for setting up the development environment and installing all necessary dependencies. ```bash ./shared/bootstrap.sh ``` -------------------------------- ### Install jsx-email with Package Managers Source: https://github.com/shellscape/jsx-email/blob/main/apps/web/src/include/install.md Install the jsx-email package using your preferred package manager. Supported managers include pnpm, bun, npm, and yarn. ```console-vue pnpm add jsx-email ``` ```console-vue bun add jsx-email ``` ```console-vue npm add jsx-email ``` ```console-vue yarn add jsx-email ``` -------------------------------- ### Create New JSX Email Project Source: https://github.com/shellscape/jsx-email/blob/main/packages/create-jsx-email/README.md Initializes a new JSX email project. This command creates a new directory with a pre-configured JSX email project structure. It is the primary way to start a new project with this tool. ```sh npm create jsx-email ``` -------------------------------- ### Check Command Example Source: https://github.com/shellscape/jsx-email/blob/main/docs/core/cli.md Illustrates the usage of the `check` command to perform a client compatibility check on an email template against compatibility tables from caniuse.com. ```console $ email check ./emails/Batman.tsx ``` -------------------------------- ### Create a New Email Template Source: https://github.com/shellscape/jsx-email/blob/main/docs/quick-start.md Creates a new email template file within a specified directory. This command generates a `.tsx` file by default, but can be configured to create `.jsx` files using a flag. ```shell $ mkdir ./emails $ email create BatmanEmail --out=./emails ``` ```shell # To create a .jsx file instead: $ email create BatmanEmail --out=./emails --jsx ``` -------------------------------- ### JSX Email Pretty Plugin Documentation Source: https://github.com/shellscape/jsx-email/blob/main/packages/plugin-pretty/README.md Documentation for the core JSX Email plugin that helps in building responsive email templates. Refer to the official documentation for detailed usage and examples. ```APIDOC Pretty Plugin: Description: A core plugin for jsx-email that provides React components and helpers for building responsive email templates. Compatibility: Compatible with modern email clients. Focus: Handles compatibility and client inconsistency. Documentation: https://jsx.email/docs/plugins/pretty ``` -------------------------------- ### Usage Example Source: https://github.com/shellscape/jsx-email/blob/main/docs/components/text.md Demonstrates how to import and use the Text component within a JSX email template. ```jsx import { Text } from 'jsx-email'; const Email = () => { return Lorem ipsum; }; ``` -------------------------------- ### Usage Example Source: https://github.com/shellscape/jsx-email/blob/main/docs/core/render.md Demonstrates how to import and use the `render` function from the 'jsx-email' package to convert a JSX email template into an HTML string. ```jsx import { render } from 'jsx-email'; import { Template } from './emails/Batman'; const html = await render(