Merge pull request #175 from code-hike/next

v0.5

Author: pomber

contributing.md

@@ -0,0 +1,11 @@
+## Files and Folders
+
+- `packages/mdx`: the npm package
+- `packages/mdx/vite.config.js`: we only use vite for testing with vitest
+- `packages/mdx/rollup.config.js`: rollup builds the thing we release to npm
+- `packages/mdx/next.config.js`: we have a nextjs testing site, our poor man's storybook
+- `packages/mdx/pages`: the pages for the nextjs test site
+- `packages/mdx/dev`: code and content used by the nextjs test site
+- `packages/mdx/src/remark`: the code that runs at build time when you compile an mdx file
+- `examples`: a list of examples, most of them use the Code Hike version from `packages/mdx/dist`
+- `examples/bundle-test`: this one is used by `.github/workflows/bundle-analysis.yml`

examples/contentlayer/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["next/babel"]
+}

examples/contentlayer/.gitignore

@@ -0,0 +1,39 @@
+# 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
+
+
+# Contentlayer
+.contentlayer

examples/contentlayer/README.md

@@ -0,0 +1,3 @@
+# Next.js + Contentlayer + Code Hike
+
+See [this guide](https://codehike.org/docs/installation/contentlayer).

examples/contentlayer/contentlayer.config.js

@@ -0,0 +1,31 @@
+import { defineDocumentType, makeSource } from "contentlayer/source-files"
+import { remarkCodeHike } from "@code-hike/mdx"
+import { createRequire } from "module"
+const require = createRequire(import.meta.url)
+const theme = require("shiki/themes/dark-plus.json")
+
+const Post = defineDocumentType(() => ({
+  name: "Post",
+  filePathPattern: `**/*.mdx`,
+  contentType: "mdx",
+  fields: {
+    title: {
+      type: "string",
+      description: "The title of the post",
+      required: true,
+    },
+  },
+  computedFields: {
+    url: {
+      type: "string",
+      resolve: (doc) => `/posts/${doc._raw.flattenedPath}`,
+    },
+  },
+}))
+
+export default makeSource({
+  contentDirPath: "posts",
+  documentTypes: [Post],
+
+  mdx: { remarkPlugins: [[remarkCodeHike, { theme }]] },
+})

examples/contentlayer/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

examples/contentlayer/next.config.js

@@ -0,0 +1,5 @@
+const { withContentlayer } = require("next-contentlayer")
+
+module.exports = withContentlayer(
+  {} // Next.js config here
+)

examples/contentlayer/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "codehike-contentlayer",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "INIT_CWD=$PWD next build",
+    "start": "next start"
+  },
+  "dependencies": {
+    "@code-hike/mdx": "^0.4.0",
+    "@types/node": "^17.0.30",
+    "contentlayer": "latest",
+    "next": "^12.1.0",
+    "next-contentlayer": "latest",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
+  },
+  "devDependencies": {
+    "@types/react": "^17.0.2",
+    "typescript": "4.6.3"
+  }
+}

examples/contentlayer/pages/_app.tsx

@@ -0,0 +1,7 @@
+import "@code-hike/mdx/dist/index.css"
+
+function MyApp({ Component, pageProps }) {
+  return <Component {...pageProps} />
+}
+
+export default MyApp

examples/contentlayer/pages/index.tsx

@@ -0,0 +1,24 @@
+import Link from "next/link"
+import { allPosts, Post } from "contentlayer/generated"
+
+export async function getStaticProps() {
+  return { props: { posts: allPosts } }
+}
+
+export default function Home({ posts }: { posts: Post[] }) {
+  return (
+    <div>
+      <h1>A Blog</h1>
+      Posts:
+      <ul>
+        {posts.map((post, idx) => (
+          <li key={idx}>
+            <Link href={post.url}>
+              <a>{post.title}</a>
+            </Link>
+          </li>
+        ))}
+      </ul>
+    </div>
+  )
+}