[docs] Update on-demand docs to avoid DEV JSX runtime #2204
Conversation
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
The example code above will (since version 2.2) throw an error because `_jsxDEV is not a function`. To avoid that, we need to pass the `development: false` option, so I've updated these docs to do so.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Codecov ReportBase: 100.00% // Head: 100.00% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #2204 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 2064 2064
=========================================
Hits 2064 2064 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
| const code = String(await compile('# hi', {outputFormat: 'function-body' /* …otherOptions */ })) | ||
| const code = String(await compile('# hi', { | ||
| outputFormat: 'function-body', | ||
| development: false, // Avoid use of the jsxDEV runtime |
There was a problem hiding this comment.
I’m thinking maybe something like this? It’s a bit annoying, because it’s all very situational.
Suggested change
| development: false, // Avoid use of the jsxDEV runtime | |
| // development: false, // Use this to avoid use of jsx-dev-runtime during development |
Maybe for the client we can use:
import {run} from '@mdx-js/mdx'
import * as runtime from 'react/jsx-runtime'
import * as devRuntime from 'react/jsx-dev-runtime'
const code = '' // To do: get `code` from server somehow.
const deveopment = process.env.NODE_ENV // To do: determine development mode for your setup.
const {default: Content} = await run(code, development ? devRuntime : runtime)
wooorm
reviewed
Jan 2, 2023
| const code = String(await compile('# hi', {outputFormat: 'function-body' /* …otherOptions */ })) | ||
| const code = String(await compile('# hi', { | ||
| outputFormat: 'function-body', | ||
| development: false, // Avoid use of the jsxDEV runtime |
There was a problem hiding this comment.
Suggested change
| development: false, // Avoid use of the jsxDEV runtime | |
| development: false, // Generate code for production. |
I’d suggest this: better to document what this does, instead of double negatives.
Alternatively, you can show both dev and prod versions
Suggested change
| development: false, // Avoid use of the jsxDEV runtime | |
| development: false, // Generate code for production. | |
| // developmment: true, // Pass this to generate development code. |
And then use the following below:
import * as runtime from 'react/jsx-runtime' // Production.
// import * as runtime from 'react/jsx-dev-runtime' // Development.
| await compile('# hi', {outputFormat: 'function-body' /* …otherOptions */}) | ||
| await compile('# hi', { | ||
| outputFormat: 'function-body', | ||
| development: false, // Avoid use of the jsxDEV runtime |
wooorm
added a commit
that referenced
this pull request
Feb 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The example code above will (since version 2.2) throw an error because
_jsxDEV is not a function.To avoid that, we need to pass the
development: falseoption, so I've updated these docs to do so.See: #2203