[site/infra,#94][l]: switch from next/mdx to contentlayerfor rendering markdown files.

* Move all markdown into a dedicated `content/` directory
* use contentlayer (https://github.com/contentlayerdev/contentlayer) for loading markdown
* add catch all route pages/[...slug].js to generate all markdown routes using contentlayer to find pages

frontmatter now properly supported

NB: some nice side benefits like removing the hack in _app.js to render markdown template vs the general layout template

TODO: page titles need fixing

site/.gitignore

@@ -32,3 +32,6 @@ yarn-error.log*
 
 # vercel
 .vercel
+
+# Contentlayer
+.contentlayer

site/components/MDX.js

@@ -1,33 +1,29 @@
 import Head from 'next/head'
 import Link from 'next/link'
-import { MDXProvider } from '@mdx-js/react'
-
 
 const components = {
   Head,
 }
 
 export default function MdxPage({ children }) {
-  const { Component, pageProps } = children
+  const { Component, frontmatter } = children
 
   return (
     <article className="prose dark:prose-invert mx-auto p-6">
       <header>
         <div className="mb-6">
-          <h1>{pageProps.title}</h1>
-          {pageProps.author && (
-            <div className="-mt-6"><p className="opacity-60 pl-1">{pageProps.author}</p></div>
+          <h1>{frontmatter.title}</h1>
+          {frontmatter.authors && (
+            <div className="-mt-6"><p className="opacity-60 pl-1">{frontmatter.authors}</p></div>
           )}
-          {pageProps.description && (
-            <p className="description">{pageProps.description}</p>
+          {frontmatter.description && (
+            <p className="description">{frontmatter.description}</p>
           )}
         </div>
       </header>
-      <section>
-        <MDXProvider components={components}>
-          <Component {...pageProps} />
-        </MDXProvider>
-      </section>
+      <main>
+        <Component components={components} />
+      </main>
     </article>
   )
 }

site/contentlayer.config.ts

@@ -0,0 +1,23 @@
+import { defineDocumentType, makeSource } from 'contentlayer/source-files'
+// import readingTime from 'reading-time'
+import remarkGfm from 'remark-gfm';
+
+const OtherPage = defineDocumentType(() => ({
+  name: 'OtherPage',
+  filePathPattern: '**/*.md*',
+  contentType: 'mdx',
+  fields: {
+    title: { type: 'string', required: false },
+    date: { type: 'string', required: false },
+    authors: { type: 'string', required: false },
+    description: { type: 'string', required: false },
+  }
+}));
+
+export default makeSource({
+  contentDirPath: 'content',
+  documentTypes: [OtherPage],
+  mdx: {
+    remarkPlugins: [remarkGfm],
+  }
+})

site/jsconfig.json

@@ -1,12 +1,16 @@
 {
   "compilerOptions": {
     "baseUrl": ".",
+    "paths": {
+      "contentlayer/generated": ["./.contentlayer/generated"]
+    }
   },
   "include": [
     "**/*.ts",
     "**/*.tsx",
     "**/*.js",
     "**/*.jsx",
+    ".contentlayer/generated", "contentlayer.config.js",
   ],
   "exclude": ["node_modules"]
-}
+}

site/next.config.mjs

@@ -1,29 +1,10 @@
-import gfm from 'remark-gfm'
-import toc from 'remark-toc'
-import slug from 'remark-slug'
-import smartypants from '@silvenon/remark-smartypants'
-
-import withMDXImp from '@next/mdx'
-
-const withMDX = withMDXImp({
-  extension: /\.mdx?$/,
-  options: {
-    remarkPlugins: [gfm, toc, slug, smartypants],
-    rehypePlugins: [],
-    // If you use `MDXProvider`, uncomment the following line.
-    providerImportSource: "@mdx-js/react",
-  },
-})
-
-
 const config = {
-  // Append the default value with md extensions
-  pageExtensions: ['ts', 'tsx', 'js', 'jsx', 'md', 'mdx'],
   webpack: (config, { buildId, dev }) => {
     config.resolve.symlinks = false
     return config
   },
 }
 
+import { withContentlayer } from 'next-contentlayer'
 
-export default withMDX(config)
+export default withContentlayer()(config)

site/package.json

@@ -14,8 +14,10 @@
     "@next/mdx": "^12.1.0",
     "@silvenon/remark-smartypants": "^1.0.0",
     "@tailwindcss/typography": "^0.5.2",
+    "contentlayer": "^0.1.2",
     "gray-matter": "^4.0.3",
     "next": "^12.1.0",
+    "next-contentlayer": "^0.1.2",
     "next-seo": "^4.28.1",
     "next-themes": "^0.1.1",
     "react": "^17.0.2",

site/pages/[...slug].js

@@ -0,0 +1,46 @@
+import MdxPage from '../components/MDX';
+import { allOtherPages } from 'contentlayer/generated';
+import { useMDXComponent } from 'next-contentlayer/hooks';
+import { NewsArticleJsonLd } from 'next-seo';
+
+
+export default function Page({ body, ...rest }) {
+  const Component = useMDXComponent(body.code);
+  const children = {
+    Component,
+    frontmatter: {
+      authors: rest.authors,
+      title: rest.title,
+      date: rest.date,
+      description: rest.description,
+      modified: rest.modified,
+      tags: rest.tags,
+    }
+  }
+  return (
+    <MdxPage children={children} />
+  );
+}
+
+export const getStaticProps = async ({ params }) => {
+  // All pages ending with .md in the /data folder are made available in allOtherPages
+  // Based on the specified slug, the correct page is selected
+  const urlPath = params.slug.join('/')
+  const page = allOtherPages.find(p => p._raw.flattenedPath === urlPath)
+  return { props: page }
+}
+
+export const getStaticPaths = async () => {
+  const paths = allOtherPages.map((page) => {
+    // demo => [demo]
+    // abc/demo => [abc,demo]
+    const parts = page._raw.flattenedPath.split('/')
+    return { params: { slug: parts } }
+  })
+
+  return {
+    paths,
+    fallback: false,
+  }
+}
+

site/pages/_app.js

@@ -26,13 +26,14 @@ function MyApp({ Component, pageProps }) {
   }
   // end Google Analytics
 
-  const pageTitle = (
-    router.pathname == "/"
-      ? "home"
-        // convert slug to title
-      : router.pathname.split("/").pop().replace(/-/g, " ")
-  ) // capitalize first char of each word
-    .replace(/(^\w{1})|(\s{1}\w{1})/g, (str) => str.toUpperCase());
+  // console.log(Component)
+  // const pageTitle = (
+  //   router.pathname == "/"
+  //     ? "home"
+  //       // convert slug to title
+  //     : router.pathname.split("/").pop().replace(/-/g, " ")
+  // ) // capitalize first char of each word
+  //   .replace(/(^\w{1})|(\s{1}\w{1})/g, (str) => str.toUpperCase());
   
   return (
     <ThemeProvider attribute="class" defaultTheme="dark">
@@ -65,19 +66,11 @@ function MyApp({ Component, pageProps }) {
           }}
         />
       )}
-      <Layout title={pageTitle}>
-        {Component.layout == "js" ? (
-          <Component {...pageProps} />
-        ) : (
-          <MdxPage children={{ Component, pageProps }} />
-        )}
+      <Layout title={""}>
+        <Component {...pageProps} />
       </Layout>
     </ThemeProvider>
   );
 }
 
-      // if this is a markdown page use this layout by default ...
-      // const MyLayout = pageProps.
-  
-
-export default MyApp
+export default MyApp