V2: robots.txt, sitemap.xml, image resizing, etc (#2895)

Author: SamyPesse

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/layout.tsx

@@ -1,16 +1,21 @@
 import { CustomizationRootLayout } from '@/components/RootLayout';
-import { SiteLayout } from '@/components/SiteLayout';
+import {
+ SiteLayout,
+ generateSiteLayoutMetadata,
+ generateSiteLayoutViewport,
+} from '@/components/SiteLayout';
 import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
 import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
 import { getThemeFromMiddleware } from '@v2/lib/middleware';
 
+interface SiteDynamicLayoutProps {
+ params: Promise<RouteLayoutParams>;
+}
+
 export default async function SiteDynamicLayout({
  params,
  children,
-}: {
- params: Promise<RouteLayoutParams>;
- children: React.ReactNode;
-}) {
+}: React.PropsWithChildren<SiteDynamicLayoutProps>) {
  const context = await getDynamicSiteContext(await params);
  const forcedTheme = await getThemeFromMiddleware();
 
@@ -26,3 +31,13 @@ export default async function SiteDynamicLayout({
  </CustomizationRootLayout>
  );
 }
+
+export async function generateViewport({ params }: SiteDynamicLayoutProps) {
+ const context = await getDynamicSiteContext(await params);
+ return generateSiteLayoutViewport(context);
+}
+
+export async function generateMetadata({ params }: SiteDynamicLayoutProps) {
+ const context = await getDynamicSiteContext(await params);
+ return generateSiteLayoutMetadata(context);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/llms.txt/route.ts

@@ -0,0 +1,12 @@
+import type { NextRequest } from 'next/server';
+
+import { serveLLMsTxt } from '@/routes/llms';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function GET(
+ _request: NextRequest,
+ { params }: { params: Promise<RouteLayoutParams> }
+) {
+ const context = await getDynamicSiteContext(await params);
+ return serveLLMsTxt(context);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/robots.txt/route.ts

@@ -0,0 +1,12 @@
+import type { NextRequest } from 'next/server';
+
+import { serveRobotsTxt } from '@/routes/robots';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function GET(
+ _request: NextRequest,
+ { params }: { params: Promise<RouteLayoutParams> }
+) {
+ const context = await getDynamicSiteContext(await params);
+ return serveRobotsTxt(context);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/sitemap-pages.xml/route.ts

@@ -0,0 +1,12 @@
+import type { NextRequest } from 'next/server';
+
+import { servePagesSitemap } from '@/routes/sitemap';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function GET(
+ _request: NextRequest,
+ { params }: { params: Promise<RouteLayoutParams> }
+) {
+ const context = await getDynamicSiteContext(await params);
+ return servePagesSitemap(context);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/sitemap.xml/route.ts

@@ -0,0 +1,12 @@
+import type { NextRequest } from 'next/server';
+
+import { serveRootSitemap } from '@/routes/sitemap';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function GET(
+ _request: NextRequest,
+ { params }: { params: Promise<RouteLayoutParams> }
+) {
+ const context = await getDynamicSiteContext(await params);
+ return serveRootSitemap(context);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/~gitbook/icon/route.ts

@@ -0,0 +1,14 @@
+import type { NextRequest } from 'next/server';
+
+import { serveIcon } from '@/routes/icon';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export const dynamic = 'force-static';
+
+export async function GET(
+ request: NextRequest,
+ { params }: { params: Promise<RouteLayoutParams> }
+) {
+ const context = await getDynamicSiteContext(await params);
+ return serveIcon(context, request);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/~gitbook/ogimage/[pageId]/route.ts

@@ -0,0 +1,13 @@
+import type { NextRequest } from 'next/server';
+
+import type { PageIdParams } from '@/components/SitePage';
+import { serveOGImage } from '@/routes/ogimage';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function GET(
+ _request: NextRequest,
+ { params }: { params: Promise<RouteLayoutParams & PageIdParams> }
+) {
+ const context = await getDynamicSiteContext(await params);
+ return serveOGImage(context, await params);
+}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/layout.tsx

@@ -1,17 +1,22 @@
 import { CustomizationRootLayout } from '@/components/RootLayout';
-import { SiteLayout } from '@/components/SiteLayout';
+import {
+ SiteLayout,
+ generateSiteLayoutMetadata,
+ generateSiteLayoutViewport,
+} from '@/components/SiteLayout';
 import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
 import { getSiteCacheTag } from '@v2/lib/cache';
 import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
 import { unstable_cacheTag as cacheTag } from 'next/cache';
 
+interface SiteStaticLayoutProps {
+ params: Promise<RouteLayoutParams>;
+}
+
 export default async function SiteStaticLayout({
  params,
  children,
-}: {
- params: Promise<RouteLayoutParams>;
- children: React.ReactNode;
-}) {
+}: React.PropsWithChildren<SiteStaticLayoutProps>) {
  'use cache';
 
  const context = await getStaticSiteContext(await params);
@@ -26,3 +31,13 @@ export default async function SiteStaticLayout({
  </CustomizationRootLayout>
  );
 }
+
+export async function generateViewport({ params }: SiteStaticLayoutProps) {
+ const context = await getStaticSiteContext(await params);
+ return generateSiteLayoutViewport(context);
+}
+
+export async function generateMetadata({ params }: SiteStaticLayoutProps) {
+ const context = await getStaticSiteContext(await params);
+ return generateSiteLayoutMetadata(context);
+}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/llms.txt/route.ts

@@ -0,0 +1,14 @@
+import type { NextRequest } from 'next/server';
+
+import { serveLLMsTxt } from '@/routes/llms';
+import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
+
+export const dynamic = 'force-static';
+
+export async function GET(
+ _request: NextRequest,
+ { params }: { params: Promise<RouteLayoutParams> }
+) {
+ const context = await getStaticSiteContext(await params);
+ return serveLLMsTxt(context);
+}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/robots.txt/route.ts

@@ -0,0 +1,14 @@
+import type { NextRequest } from 'next/server';
+
+import { serveRobotsTxt } from '@/routes/robots';
+import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
+
+export const dynamic = 'force-static';
+
+export async function GET(
+ _request: NextRequest,
+ { params }: { params: Promise<RouteLayoutParams> }
+) {
+ const context = await getStaticSiteContext(await params);
+ return serveRobotsTxt(context);
+}