renderToMarkup -> renderToHTML

reactjs · Aug 14, 2024 · be631eb · be631eb
1 parent c0bd72d
commit be631eb
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 15 deletions.
diff --git a/src/content/reference/react-markup/index.md b/src/content/reference/react-markup/index.md
@@ -13,4 +13,4 @@ It cannot use Client Components and does not hydrate. It is intended to be paire
 
 These APIs can be imported from the React Server environment (e.g. in Server Actions):
 
-* [`renderToMarkup`](/reference/react-markup/renderToMarkup) renders a non-interactive React tree with support for Server Components but not Client Components. 
+* [`renderToHTML`](/reference/react-markup/renderToHTML) renders a non-interactive React tree with support for Server Components but not Client Components. 
diff --git a/.../reference/react-markup/renderToMarkup.md → ...nt/reference/react-markup/renderToHTML.md b/.../reference/react-markup/renderToMarkup.md → ...nt/reference/react-markup/renderToHTML.md
@@ -1,14 +1,15 @@
 ---
-title: renderToMarkup
+title: renderToHTML
+canary: true
 ---
 
 
 <Intro>
 
-`renderToMarkup` renders a React tree to non-interactive HTML.
+`renderToHTML` renders a React tree to non-interactive HTML.
 
 ```js
-const stream = renderToMarkup(reactNode, options?)
+const stream = renderToHTML(reactNode, options?)
 ```
 
 </Intro>
@@ -19,14 +20,19 @@ const stream = renderToMarkup(reactNode, options?)
 
 ## Reference {/*reference*/}
 
-### `renderToMarkup(reactNode, options?)` {/*renderToMarkup*/}
+### `renderToHTML(reactNode, options?)` {/*rendertohtml*/}
 
-You can call `renderToMarkup` in a React Server environment (e.g. in a Server Action) to render a non-interactive tree of React components to HTML.
+You can call `renderToHTML` to render a non-interactive tree of React components to HTML.
+By default, it supports shared components and built-in components.
+Server Components are only allowed if used in a React Server environment (e.g. in Server Actions).
+You can also use it during Client-Side Rendering but only without Server Components.
+
+When a `<html>` tag is rendered, `renderToHTML` will automatically add `<!DOCTYPE html>` doctype.
 
 ```js
-import { renderToMarkup } from 'react-dom/server';
+import { experimental_renderToHTML as renderToHTML } from 'react-dom/server';
 
-const markup = await renderToMarkup(<App />);
+const markup = await renderToHTML(<App />);
 ```
 
 #### Parameters {/*parameters*/}
@@ -40,28 +46,28 @@ const markup = await renderToMarkup(<App />);
 
 #### Returns {/*returns*/}
 
-`renderToMarkup` returns a Promise that will resolve with the HTML string of the rendered React tree.
+`renderToHTML` returns a Promise that will resolve with the HTML string of the rendered React tree.
 
 #### Caveats {/*caveats*/}
 
-* Will throw when Client Components (e.g. `useState` or `useEffect`) are used.
+* Will throw when Client APIs (e.g. `useState` or `useEffect`) are used.
 
 ---
 
 ## Usage {/*usage*/}
 
 ### Rendering a React tree as an Email {/*rendering-a-react-tree-as-an-email*/}
 
-Await the call of `renderToMarkup` :
+Await the call of `renderToHTML` :
 
 ```js {7}
-import { renderToMarkup } from 'react-markup';
+import { experimental_renderToHTML as renderToHTML } from 'react-markup';
 import EmailTemplate from './my-email-template-component.js'
 
 async function action(email, name) {
   "use server";
   // ... in your server, e.g. a Server Action...
-  const htmlString = await renderToMarkup(<EmailTemplate name={name} />);
+  const htmlString = await renderToHTML(<EmailTemplate name={name} />);
   // ... send e-mail using some e-mail provider
   await sendEmail({ to: email, contentType: 'text/html', body: htmlString });
 }

diff --git a/src/sidebarReference.json b/src/sidebarReference.json
@@ -396,8 +396,8 @@
       "canary": true,
       "routes": [
         {
-          "title": "renderToMarkup",
-          "path": "/reference/react-markup/renderToMarkup",
+          "title": "renderToHTML",
+          "path": "/reference/react-markup/renderToHTML",
           "canary": true
         }
       ]