Files
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 <[email protected]>
2025-01-07 18:53:42 -08:00

83 lines
2.3 KiB
TypeScript

import Image from "next/image";
import { Inter } from "next/font/google";
import styles from "./page.module.css";
import Content from "./message.mdx";
const inter = Inter({ subsets: ["latin"] });
export default function Home() {
return (
<main className={`${styles.main} ${inter.className}`}>
<div className={styles.description}>
<p>
Get started by editing&nbsp;
<code className={styles.code}>app/page.tsx</code>
</p>
<div>
<a
href="https://vercel.com?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
target="_blank"
rel="noopener noreferrer"
>
By{" "}
<Image
src="/vercel.svg"
alt="Vercel Logo"
className={styles.vercelLogo}
width={100}
height={24}
priority
/>
</a>
</div>
</div>
<div className={styles.center}>
<div>
<Content />
</div>
</div>
<div className={styles.grid}>
<a
href="https://nextjs.org/docs?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
className={styles.card}
target="_blank"
rel="noopener noreferrer"
>
<h2>
Docs <span>-&gt;</span>
</h2>
<p>Find in-depth information about Next.js features and API.</p>
</a>
<a
href="https://vercel.com/templates?framework=next.js&utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
className={styles.card}
target="_blank"
rel="noopener noreferrer"
>
<h2>
Templates <span>-&gt;</span>
</h2>
<p>Explore starter templates for Next.js.</p>
</a>
<a
href="https://vercel.com/new?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
className={styles.card}
target="_blank"
rel="noopener noreferrer"
>
<h2>
Deploy <span>-&gt;</span>
</h2>
<p>
Instantly deploy your Next.js site to a shareable URL with Vercel.
</p>
</a>
</div>
</main>
);
}