vercel__next.js/examples/mdx-pages/package.json at codex/fallback-root-cache - vercel__next.js - GetSkill.work

skills/vercel__next.js

mirror of https://github.com/vercel/next.js.git synced 2026-09-20 02:25:18 +08:00

Files

T

Jam Balaya 832c77d01f examples: remove app-dir and with prefix in the mdx directory name (#73458 )

## What?

1. Rename the following examples.

| Before | After |
|--------|--------|
|
[app-dir-mdx](https://github.com/vercel/next.js/tree/canary/examples/app-dir-mdx)
| mdx |
|
[with-mdx](https://github.com/vercel/next.js/tree/canary/examples/with-mdx)
| mdx-pages |
|
[with-mdx-remote](https://github.com/vercel/next.js/tree/canary/examples/with-mdx-remote)
| mdx-remote |

2. Change the example names at README.md in the repositories.
3. Update the mdx pathname in the test files.

## Why?

### Why remove `app-dir-` in the directory name?

The default has already been App Router anyways and a lot of examples
have migrated over.
x-ref:
https://github.com/vercel/next.js/pull/72642#issuecomment-2474415343

### Why remove `with-` in the directory name?

According to [examples
guidelines](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md),

> Example directories should not be prefixed with `with-`

## How did you verify your code works?

I have tested the new
[with-mdx.test.ts](https://github.com/vercel/next.js/blob/canary/test/e2e/yarn-pnp/test/with-mdx.test.ts)
and
[example.test.ts](https://github.com/vercel/next.js/blob/canary/test/examples/examples.test.ts).

### Adding or Updating Examples

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

CC: @samcx

Co-authored-by: Sam Ko <sam@vercel.com>

2025-01-07 18:53:42 -08:00

17 lines

303 B

JSON

Raw Permalink Blame History

 {
   "private": true,
   "scripts": {
     "dev": "next",
     "build": "next build",
     "start": "next start"
   },
   "dependencies": {
     "@mdx-js/loader": "^1.5.1",
     "@mdx-js/react": "^1.6.18",
     "@next/mdx": "^9.1.1",
     "next": "latest",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   }
 }