seo: implement OpenAPI operation rendering and add llms documentation

2026-05-13 17:37:02 +02:00
parent 463301b5db
commit 4e95c5a4e4
11 changed files with 500 additions and 2 deletions
@@ -0,0 +1,14 @@
+export const MARKDOWN_SLUGS: ReadonlySet<string> = new Set([
+  'index',
+  'pricing',
+  'features/workflows',
+  'features/segments',
+  'features/inbound-email',
+  'features/email-editor',
+  'features/smtp',
+]);
+
+export function hasMarkdownVariant(pathname: string): boolean {
+  const slug = pathname.replace(/^\/+|\/+$/g, '') || 'index';
+  return MARKDOWN_SLUGS.has(slug);
+}
@@ -341,3 +341,5 @@ Plunk provides SMTP credentials so you can send emails from any application or f
 [Back to features](/features) | [Pricing](/pricing) | [Documentation](https://docs.useplunk.com)
 `,
 };
+
+export {MARKDOWN_SLUGS, hasMarkdownVariant} from './markdown-slugs';
@@ -1,6 +1,8 @@
 import { NextResponse } from 'next/server';
 import type { NextRequest } from 'next/server';

+import { hasMarkdownVariant } from './content/markdown-slugs';
+
 type Negotiated = 'markdown' | 'html' | 'none';

 function parseAccept(accept: string): Array<{ type: string; q: number }> {
@@ -59,6 +61,9 @@ export function middleware(request: NextRequest) {

  const response = NextResponse.next();
  response.headers.set('Vary', 'Accept');
+  if (hasMarkdownVariant(pathname)) {
+    response.headers.append('Link', `<${pathname}.md>; rel="alternate"; type="text/markdown"`);
+  }
  return response;
 }

@@ -2,9 +2,11 @@ import '../styles/globals.css';
 import React, {useEffect} from 'react';
 import Head from 'next/head';
 import {AppProps} from 'next/app';
+import {useRouter} from 'next/router';
 import {toast, Toaster} from 'sonner';
 import {SWRConfig} from 'swr';
 import {network} from '../lib/network';
+import {hasMarkdownVariant} from '../content/markdown-slugs';
 import {DefaultSeo} from 'next-seo';
 import Script from 'next/script';
 import {Bricolage_Grotesque, Hanken_Grotesk, JetBrains_Mono} from 'next/font/google';
@@ -37,6 +39,10 @@ const mono = JetBrains_Mono({
 * @param props.pageProps
 */
 function App({Component, pageProps}: AppProps) {
+  const router = useRouter();
+  const pathname = (router.asPath.split('?')[0] ?? '').split('#')[0] ?? '/';
+  const markdownHref = hasMarkdownVariant(pathname) ? `${pathname === '/' ? '/index' : pathname}.md` : null;
+
  useEffect(() => {
    const searchParams = new URLSearchParams(window.location.search);
    const message = searchParams.get('message');
@@ -51,6 +57,7 @@ function App({Component, pageProps}: AppProps) {
      <Head>
        <title>Plunk | The Open-Source Email Platform</title>
        <meta name="viewport" content="width=device-width, initial-scale=1.0" key={'viewport'} />
+        {markdownHref && <link rel="alternate" type="text/markdown" href={markdownHref} />}
      </Head>
      <Toaster position={'top-right'} />