Mdx docs improved after changing things which were wrong #36067
Closed
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
Markos-Th09
requested review from
timneutkens,
ijjk,
shuding,
styfle,
huozhi,
padmaia and
leerob
as code owners
timneutkens
reviewed
Apr 15, 2022
docs/advanced-features/using-mdx.md
Outdated
| @@ -64,6 +85,14 @@ The following steps outline how to setup `@next/mdx` in your Next.js project: | |||
| - package.json | |||
| ``` | |||
|
|
|||
| ## next-mdx-remote | |||
There was a problem hiding this comment.
These two are intentionally not mentioned as they're recommending to eval external sources that are transformed into JS.
timneutkens
reviewed
Apr 15, 2022
| @@ -98,6 +119,26 @@ author: 'Rich Haines' | |||
| # My MDX page | |||
| ``` | |||
|
|
|||
| ```js | |||
There was a problem hiding this comment.
This code block shows how to add remarkFrontmatter but the line above it shows how to add metadata using export const meta which does not require any extra configuration. Maybe this can be in it's own section?
timneutkens
reviewed
Apr 15, 2022
docs/advanced-features/using-mdx.md
Outdated
| @@ -208,5 +249,8 @@ If you use it across the site you may want to add the provider to `_app.js` so a | |||
|
|
|||
| - [MDX](https://mdxjs.com) | |||
| - [`@next/mdx`](https://www.npmjs.com/package/@next/mdx) | |||
| - [next-mdx-remote](https://github.com/hashicorp/next-mdx-remote) | |||
There was a problem hiding this comment.
Same as my earlier comment.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Documentation / Examples
yarn lintSame as Improvements to the MDX Docs and replaced a leftover reference to babel #35332 but fixes the issues mentioned