allow overriding pagination through frontmatter

Author: chargome

app/[[...path]]/page.tsx

@@ -101,21 +101,34 @@ export default async function Page({params}: {params: {path?: string[]}}) {
   }
 
   const pageNode = nodeForPath(rootNode, params.path);
-  const nextNode = pageNode ? getNextNode(pageNode) : undefined;
-  const previousNode = pageNode ? getPreviousNode(pageNode) : undefined;
-  const nextPage = nextNode
-    ? {path: nextNode.path, title: nextNode.frontmatter.title}
-    : undefined;
-  const previousPage = previousNode
-    ? {path: previousNode.path, title: previousNode.frontmatter.title}
-    : undefined;
 
   if (!pageNode) {
     // eslint-disable-next-line no-console
     console.warn('no page node', params.path);
     return notFound();
   }
 
+  // gather previous and next page that will be displayed in the bottom pagination
+  let previousPage = pageNode?.frontmatter?.previousPage;
+  let nextPage = pageNode?.frontmatter?.nextPage;
+
+  if (!nextPage || !('path' in nextPage) || !('title' in nextPage)) {
+    const nextNode = pageNode ? getNextNode(pageNode) : undefined;
+    nextPage = nextNode
+      ? {path: nextNode.path, title: nextNode.frontmatter.title}
+      : undefined;
+  }
+
+  if (!previousPage || !('path' in previousPage) || !('title' in previousPage)) {
+    const previousNode = pageNode ? getPreviousNode(pageNode) : undefined;
+    previousPage =
+      previousNode === 'root'
+        ? {path: '', title: 'Welcome to Sentry'}
+        : previousNode
+          ? {path: previousNode.path, title: previousNode.frontmatter.title}
+          : undefined;
+  }
+
   // get the MDX for the current doc and render it
   let doc: Awaited<ReturnType<typeof getFileBySlug>> | null = null;
   try {

src/types/frontmatter.ts

@@ -1,3 +1,5 @@
+import {PaginationNavNode} from './paginationNavNode';
+
 /**
  ** a YAML-formatted blob defined at the top of every markdown or mdx file
  */
@@ -23,6 +25,11 @@ export interface FrontMatter {
    * A list of keywords for indexing with search.
    */
   keywords?: string[];
+
+  /**
+   * The next page in the bottom pagination navigation.
+   */
+  nextPage?: PaginationNavNode;
   /**
    * Set this to true to disable indexing (robots, algolia) of this content.
    */
@@ -31,11 +38,20 @@ export interface FrontMatter {
    * Specific guides that this page is not relevant to.
    */
   notSupported?: string[];
+
   /**
    * Set this to true to disable page-level table of contents rendering.
    */
   notoc?: boolean;
 
+  /**
+   * The previous page in the bottom pagination navigation.
+   */
+  previousPage?: PaginationNavNode;
+
+  /**
+   * The next page in the sidebar navigation.
+   */
   /**
    * Set this to true to hide from the sidebar
    */
@@ -60,7 +76,6 @@ export interface FrontMatter {
    * Specific guides that this page is relevant to.
    */
   supported?: string[];
-
   /**
    * Available versions for this page
    * @example ['v7.119.0', 'next']