-
Notifications
You must be signed in to change notification settings - Fork 330
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[documentation] Updating README with correct renderToStaticMarkup fun…
…ction (#89)
- Loading branch information
1 parent
841f8e7
commit 0ffa4af
Showing
1 changed file
with
6 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -124,9 +124,9 @@ const CONFIGURATION: TReaderDocument = { | |
You can render the EmailBuilder.js configuration to an HTML email string: | ||
|
||
```javascript | ||
import { renderHtmlDocument } from '@usewaypoint/email-builder'; | ||
import { renderToStaticMarkup } from '@usewaypoint/email-builder'; | ||
|
||
const string = renderHtmlDocument(CONFIGURATION, 'root'); | ||
const string = renderToStaticMarkup(CONFIGURATION, { rootBlockId: 'root' }); | ||
``` | ||
|
||
Or you can render the EmailBuilder.js configuration by using the `<Reader />` React component: | ||
|
@@ -148,7 +148,7 @@ In most cases, you'll want to take the EmailBuilder.js configuration, render it | |
### Sending through nodemailer | ||
|
||
```javascript | ||
import { renderHtmlDocument } from '@usewaypoint/email-builder'; | ||
import { renderToStaticMarkup } from '@usewaypoint/email-builder'; | ||
import nodemailer from "nodemailer"; | ||
|
||
// Replace this with your transport configuration | ||
|
@@ -162,7 +162,7 @@ await transporter.sendMail({ | |
from: '[email protected]' | ||
to: '[email protected]', | ||
subject: 'Hello', | ||
html: renderHtmlDocument(CONFIGURATION, 'root'), | ||
html: renderToStaticMarkup(CONFIGURATION, { rootBlockId: 'root' }), | ||
}); | ||
``` | ||
|
||
|
@@ -175,7 +175,7 @@ We'll use [Waypoint](https://www.usewaypoint.com) for this example, however, you | |
```javascript | ||
import axios from 'axios'; | ||
|
||
import { renderHtmlDocument } from '@usewaypoint/email-builder'; | ||
import { renderToStaticMarkup } from '@usewaypoint/email-builder'; | ||
|
||
// Replace this with the JSON for your Reader document | ||
const CONFIGURATION: TReaderDocument = {} | ||
|
@@ -195,7 +195,7 @@ await axios({ | |
from: '[email protected]' | ||
to: '[email protected]', | ||
subject: 'Hello', | ||
bodyHtml: renderHtmlDocument(CONFIGURATION, 'root'), | ||
bodyHtml: renderToStaticMarkup(CONFIGURATION, { rootBlockId: 'root' }), | ||
}, | ||
}); | ||
``` | ||
|