Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct reason for Turbopack incompat, remove inaccurate "good to know" #72467

Merged
merged 2 commits into from
Nov 7, 2024

Conversation

karlhorky
Copy link
Contributor

@karlhorky karlhorky commented Nov 7, 2024

What?

  1. Fix the incorrect statement added in Note missing plugins support in mdxRs, refine #72241, as per @timneutkens' comment here:
  2. Remove the outdated "good to know" section stating that Turbopack requires mdxjs-rs and is not compatible with @next/mdx

Why?

The docs are currently incorrect

How?

Edit remark and rehype plugins section on docs page

@ijjk ijjk added the Documentation Related to Next.js' official documentation. label Nov 7, 2024
@ijjk
Copy link
Member

ijjk commented Nov 7, 2024

Allow CI Workflow Run

  • approve CI run for commit: c489891

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@timneutkens timneutkens added the CI approved Approve running CI for fork label Nov 7, 2024
@timneutkens timneutkens merged commit 81271ba into vercel:canary Nov 7, 2024
42 checks passed
ijjk pushed a commit that referenced this pull request Nov 18, 2024
Followup to #72241 and
#72467

Documenting the new Turbopack support for MDX plugins (remark, rehype,
recma plugins):

- #71819 (comment)

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->

### What?

Clarify that MDX-related plugins (remark and rehype plugins) are
supported when options are serializable, by using the new string name
config format

### Why?

Support was added in 72802

- #72802

### How?

Add a new section about using plugins with Turbopack
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CI approved Approve running CI for fork Documentation Related to Next.js' official documentation. locked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants