chore: add @next/mdx and next-mdx-remote examples

thecuvii · Oct 16, 2022 · 39bd4d8 · 39bd4d8
1 parent ca43731
commit 39bd4d8
Show file tree

Hide file tree

Showing 39 changed files with 12,280 additions and 1,987 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+examples/
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ lib-cov
 logs
 node_modules
 temp
+.next
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -2,14 +2,11 @@
   "files.eol": "\n",
   "editor.tabSize": 2,
   "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "eslint.validate": [
-    "javascript",
-    "javascriptreact",
-    "vue",
-    "typescript",
-    "typescriptreact"
-  ],
+  "eslint.validate": ["javascript", "javascriptreact", "vue", "typescript", "typescriptreact"],
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": true
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "yzhang.markdown-all-in-one"
   }
 }
diff --git a/build.config.ts b/build.config.ts
@@ -1,12 +1,10 @@
-import { defineBuildConfig } from 'unbuild'
+import { defineBuildConfig } from 'unbuild';
 
 export default defineBuildConfig({
-  entries: [
-    'src/index',
-  ],
+  entries: ['src/index'],
   declaration: true,
   clean: true,
   rollup: {
     emitCJS: true,
   },
-})
+});
diff --git a/examples/next-mdx-remote/.eslintrc.json b/examples/next-mdx-remote/.eslintrc.json
@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}
diff --git a/examples/next-mdx-remote/.gitignore b/examples/next-mdx-remote/.gitignore
@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
diff --git a/examples/next-mdx-remote/README.md b/examples/next-mdx-remote/README.md
@@ -0,0 +1,34 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
+
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
+
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
diff --git a/examples/next-mdx-remote/next.config.js b/examples/next-mdx-remote/next.config.js
@@ -0,0 +1,7 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+  swcMinify: true,
+};
+
+module.exports = nextConfig;
diff --git a/examples/next-mdx-remote/package.json b/examples/next-mdx-remote/package.json
@@ -0,0 +1,27 @@
+{
+  "name": "next.js",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@codesandbox/sandpack-react": "^1.14.2",
+    "next": "12.3.1",
+    "next-mdx-remote": "^4.1.0",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "remark-sandpack": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.0",
+    "@types/react": "18.0.21",
+    "@types/react-dom": "18.0.6",
+    "eslint": "^8.25.0",
+    "eslint-config-next": "12.3.1",
+    "typescript": "^4.8.4"
+  }
+}
diff --git a/examples/next-mdx-remote/pages/_app.tsx b/examples/next-mdx-remote/pages/_app.tsx
@@ -0,0 +1,8 @@
+import '../styles/globals.css';
+import type { AppProps } from 'next/app';
+
+function MyApp({ Component, pageProps }: AppProps) {
+  return <Component {...pageProps} />;
+}
+
+export default MyApp;
diff --git a/examples/next-mdx-remote/pages/api/hello.ts b/examples/next-mdx-remote/pages/api/hello.ts
@@ -0,0 +1,10 @@
+// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
+import type { NextApiRequest, NextApiResponse } from 'next';
+
+type Data = {
+  name: string;
+};
+
+export default function handler(req: NextApiRequest, res: NextApiResponse<Data>) {
+  res.status(200).json({ name: 'John Doe' });
+}
diff --git a/examples/next-mdx-remote/pages/content.mdx b/examples/next-mdx-remote/pages/content.mdx
@@ -0,0 +1,17 @@
+## Sandpack mdx
+
+<Sandpack options={{ showLineNumbers: true, showTabs: true }} template="react-ts">
+```tsx App.tsx
+import './styles.css'
+export default function App(): JSX.Element {
+  return <h1>Hello MDX + Sandpack</h1>
+}
+```
+
+```css styles.css file=styles/globals.css readonly
+h1 {
+  background: #ccffcc;
+}
+```
+
+</Sandpack>
diff --git a/examples/next-mdx-remote/pages/index.tsx b/examples/next-mdx-remote/pages/index.tsx
@@ -0,0 +1,34 @@
+import { readFileSync } from 'fs';
+import type { GetStaticProps, NextPage } from 'next';
+import { join } from 'path';
+import { serialize } from 'next-mdx-remote/serialize';
+import { remarkSandpack } from 'remark-sandpack';
+import { MDXRemote } from 'next-mdx-remote';
+import { Sandpack } from '@codesandbox/sandpack-react';
+interface Props {
+  source: string;
+}
+
+const Home: NextPage<Props> = ({ source }) => {
+  return (
+    <div>
+      <MDXRemote compiledSource={source} components={{ Sandpack }} />
+    </div>
+  );
+};
+
+export default Home;
+
+export const getStaticProps: GetStaticProps = async () => {
+  const source = readFileSync(join(process.cwd(), '/pages/content.mdx'), 'utf8');
+
+  const { compiledSource } = await serialize(source, {
+    mdxOptions: { remarkPlugins: [remarkSandpack], format: 'mdx' },
+  });
+
+  return {
+    props: {
+      source: compiledSource,
+    },
+  };
+};
diff --git a/examples/next-mdx-remote/public/favicon.ico b/examples/next-mdx-remote/public/favicon.ico
diff --git a/examples/next-mdx-remote/public/vercel.svg b/examples/next-mdx-remote/public/vercel.svg
diff --git a/examples/next-mdx-remote/styles/Home.module.css b/examples/next-mdx-remote/styles/Home.module.css
@@ -0,0 +1,129 @@
+.container {
+  padding: 0 2rem;
+}
+
+.main {
+  min-height: 100vh;
+  padding: 4rem 0;
+  flex: 1;
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  align-items: center;
+}
+
+.footer {
+  display: flex;
+  flex: 1;
+  padding: 2rem 0;
+  border-top: 1px solid #eaeaea;
+  justify-content: center;
+  align-items: center;
+}
+
+.footer a {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  flex-grow: 1;
+}
+
+.title a {
+  color: #0070f3;
+  text-decoration: none;
+}
+
+.title a:hover,
+.title a:focus,
+.title a:active {
+  text-decoration: underline;
+}
+
+.title {
+  margin: 0;
+  line-height: 1.15;
+  font-size: 4rem;
+}
+
+.title,
+.description {
+  text-align: center;
+}
+
+.description {
+  margin: 4rem 0;
+  line-height: 1.5;
+  font-size: 1.5rem;
+}
+
+.code {
+  background: #fafafa;
+  border-radius: 5px;
+  padding: 0.75rem;
+  font-size: 1.1rem;
+  font-family: Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono,
+    Bitstream Vera Sans Mono, Courier New, monospace;
+}
+
+.grid {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  flex-wrap: wrap;
+  max-width: 800px;
+}
+
+.card {
+  margin: 1rem;
+  padding: 1.5rem;
+  text-align: left;
+  color: inherit;
+  text-decoration: none;
+  border: 1px solid #eaeaea;
+  border-radius: 10px;
+  transition: color 0.15s ease, border-color 0.15s ease;
+  max-width: 300px;
+}
+
+.card:hover,
+.card:focus,
+.card:active {
+  color: #0070f3;
+  border-color: #0070f3;
+}
+
+.card h2 {
+  margin: 0 0 1rem 0;
+  font-size: 1.5rem;
+}
+
+.card p {
+  margin: 0;
+  font-size: 1.25rem;
+  line-height: 1.5;
+}
+
+.logo {
+  height: 1em;
+  margin-left: 0.5rem;
+}
+
+@media (max-width: 600px) {
+  .grid {
+    width: 100%;
+    flex-direction: column;
+  }
+}
+
+@media (prefers-color-scheme: dark) {
+  .card,
+  .footer {
+    border-color: #222;
+  }
+  .code {
+    background: #111;
+  }
+  .logo img {
+    filter: invert(1);
+  }
+}
diff --git a/examples/next-mdx-remote/styles/globals.css b/examples/next-mdx-remote/styles/globals.css
@@ -0,0 +1,30 @@
+html,
+body {
+  padding: 0;
+  margin: 0;
+  font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans,
+    Helvetica Neue, sans-serif;
+}
+
+a {
+  color: inherit;
+  text-decoration: none;
+}
+
+* {
+  box-sizing: border-box;
+}
+
+@media (prefers-color-scheme: dark) {
+  html {
+    color-scheme: dark;
+  }
+  body {
+    color: white;
+    background: black;
+  }
+}
+
+h1 {
+  background-color: #ccffcc;
+}