npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@recontentapp/studio

v0.3.1

Published

> A local environment to develop MJML email templates & layouts

Downloads

214

Readme

Recontent Studio

A local environment to develop MJML email templates & layouts

Recontent Studio

  • Live responsive preview: Check how your template looks for different screen sizes with hot reload
  • Localization: Localize content & preview templates in multiple languages
  • JSON schemas: Pass variables to templates & preview them with fake data
  • Reusable layouts: Share the same structure across multiple templates
  • Typed email renderer: Generate a Typescript email renderer for your templates

Installation

Recontent Studio is a command-line interface (CLI) that can be installed globally or as a dev dependency of your project.

npm install -g @recontentapp/studio

npm install @recontentapp/studio --save-dev

Using the studio

A recommended folder structure for MJML templates & layouts looks like this:

  • Each .mjml template belongs to a dedicated folder with its associated files
  • Reusable layouts are grouped in a separate folder

You can get started by scaffolding a default folder structure using the following command:

recontent new my-templates
.
├── layouts
│   └── default
│       ├── config.json
│       └── template.mjml
└── templates
    └── webinar-announcement
        ├── config.json
        ├── content.en.json
        ├── content.fr.json
        └── template.mjml

To launch the studio, run the following command with your folder's path.

recontent studio ./path/to/folder

Generating a typed email renderer

To generate a typed email renderer, run the following command with your folder's path & the desired output folder. An emailRenderer.ts file will be generated in the output folder.

recontent compile ./path/to/folder --output ./src/emails

To use the email renderer, make sure to install @recontentapp/email-renderer as a dependency of your project. This package is used to render your email templates as HTML with passed variables.

npm install @recontentapp/email-renderer

yarn add @recontentapp/email-renderer

in your application code, you can then use your typed email renderer to send emails:

import { emailRenderer } from 'src/emails/emailRenderer'

const sendEmail = async () => {
  const html = emailRenderer.webinarAnnouncement({
    locale: 'en',
    data: {
      link: 'https://example.com',
    },
  })

  // TODO: Send email
}