Upgrade next-mdx-remote and other markdown-related dependencies
#321
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
github-actions
bot
added
area: dependencies
This was referenced Jun 3, 2022
kachkaev
commented
Jun 10, 2022
| @@ -3,11 +3,10 @@ import matter from "gray-matter"; | |||
| import { MDXRemoteSerializeResult } from "next-mdx-remote"; | |||
| import { serialize } from "next-mdx-remote/serialize"; | |||
There was a problem hiding this comment.
This was impossible without #322 because next-mdx-remote/serialize v2 is ESM only. The build script was crashing.
kachkaev
commented
Jun 10, 2022
| import remarkMdx from "remark-mdx"; | ||
| import remarkParse from "remark-parse"; | ||
| import slugify from "slugify"; | ||
| import unified from "unified"; | ||
| import { unified } from "unified"; |
There was a problem hiding this comment.
Breaking change in unified
kachkaev
commented
Jun 10, 2022
| @@ -30,14 +30,12 @@ The JSON metadata file should look like this: | |||
| } | |||
| ``` | |||
|
|
|||
| <!-- markdownlint-disable no-emphasis-as-heading --> | |||
There was a problem hiding this comment.
MDX 2 requires comments to be in {* *} instead of <!-- -->, which Prettier does on like. Upstream issues: prettier/prettier#12209 / hashicorp/next-mdx-remote#277
In the meantime, if we do need to disable a markdownlint rule, we can do so in .markdownlint.json. I switched to regular MD headers here to avoid that. The text is a bit bigger than before but the doc looks good overall.
CiaranMn
approved these changes
Jun 13, 2022
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.
Unblocks:
Was blocked by:
next-mdx-remote@v2is ESM-only, so we need to finish Addtype: moduleto site and to monorepo root and use ESM in scripts #322 firstRelated links:
How to test:
/docsand/specs```block-function.