Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve metadata defaults + og image #391

Merged
merged 8 commits into from
Apr 29, 2024
Merged

improve metadata defaults + og image #391

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e261662
improve metadata defaults + og image
Illyism Apr 28, 2024
dc55335
Fix API views handle function to return early when method is not POST
Illyism Apr 28, 2024
a77c9fa
default
Illyism Apr 28, 2024
cdf3354
chore: run prettier
mfts Apr 29, 2024
a3d9e7e
fix: add title
mfts Apr 29, 2024
7cf6940
chore: add alt title
mfts Apr 29, 2024
99b4148
refactor: cleanup custom meta conditionals
mfts Apr 29, 2024
ab8cb7a
fix: link may be null
mfts Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions app/api/og/route.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/* eslint-disable @next/next/no-img-element */
import { ImageResponse } from "next/og";
import { NextRequest } from "next/server";

export const runtime = "edge";

/**
* @name Headline Template
* @description Make it pop with a headline
*/
export async function GET(request: NextRequest) {
const searchParams = request.nextUrl.searchParams;
const title = searchParams.get("title") || "Papermark Document";
const Inter = await fetch(
new URL("@/public/_static/Inter-Bold.ttf", import.meta.url),
).then((res) => res.arrayBuffer());

return new ImageResponse(
(
<div tw="flex flex-col items-center justify-between w-full h-full bg-white text-black p-12">
<div tw="text-[32px] flex items-center tracking-tighter">Papermark</div>
<div tw="text-[42px] text-center">{title}</div>
<div tw="text-[32px] flex items-center">
Open-Source Document Sharing
</div>
</div>
),
{
width: 1200,
height: 630,
headers: {
"Cache-Control": "public, max-age=3600, immutable",
},
fonts: [
{
name: "Inter",
data: Inter,
},
],
},
);
}
90 changes: 60 additions & 30 deletions components/view/custom-metatag.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,76 @@
import Head from "next/head";

const CustomMetatag = ({
enableBranding,
title,
description,
imageUrl,
url,
}: {
enableBranding: boolean;
title: string | null;
description: string | null;
imageUrl: string | null;
url: string;
}) => {
return (
<Head>
{title ? <title>{title}</title> : null}
{description ? (
<meta name="description" content={description} key="description" />
) : null}
{title ? (
<meta property="og:title" content={title} key="og-title" />
) : null}
{description ? (
<meta
property="og:description"
content={description}
key="og-description"
/>
) : null}
{imageUrl ? (
<meta property="og:image" content={imageUrl} key="og-image" />
) : null}
{title ? (
<meta name="twitter:title" content={title} key="tw-title" />
) : null}
{description ? (
<meta
name="twitter:description"
content={description}
key="tw-description"
/>
) : null}
{imageUrl ? (
<meta name="twitter:image" content={imageUrl} key="tw-image" />
) : null}
{url && (
<>
<link rel="canonical" href={url} key="canonical" />
<meta property="og:url" content={url} key="og-url" />
</>
)}
{title && (
<>
<title>{title}</title>
<meta property="og:title" content={title} key="og-title" />
<meta name="twitter:title" content={title} key="tw-title" />
</>
)}
{!enableBranding && (
<>
<meta
property="og:image"
content={`/api/og?title=${title ?? ""}`}
key="og-image"
/>
<meta
name="twitter:image"
content={`/api/og?title=${title ?? ""}`}
key="tw-image"
/>
</>
)}
{enableBranding && (
<>
{description ? (
<>
<meta
name="description"
content={description}
key="description"
/>
<meta
property="og:description"
content={description}
key="og-description"
/>
<meta
name="twitter:description"
content={description}
key="tw-description"
/>
</>
) : null}
{imageUrl ? (
<>
<meta property="og:image" content={imageUrl} key="og-image" />
<meta name="twitter:image" content={imageUrl} key="tw-image" />
</>
) : null}
</>
)}
</Head>
);
};
Expand Down
65 changes: 23 additions & 42 deletions pages/view/[linkId]/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,20 +118,15 @@ export default function ViewPage({
if (!link || status === "loading" || router.isFallback) {
return (
<>
<Head>
<meta
property="og:url"
key="og-url"
content={`https://www.papermark.io/view/${router.query.linkId}`}
/>
</Head>
{meta && meta.enableCustomMetatag ? (
<CustomMetatag
title={meta.metaTitle}
description={meta.metaDescription}
imageUrl={meta.metaImage}
/>
) : null}
<CustomMetatag
enableBranding={meta?.enableCustomMetatag ?? false}
title={
meta?.metaTitle ?? link?.document?.name ?? "Papermark Document"
}
description={meta?.metaDescription ?? null}
imageUrl={meta?.metaImage ?? null}
url={`https://www.papermark.io/view/${router.query.linkId}`}
/>
<div className="h-screen flex items-center justify-center">
<LoadingSpinner className="h-20 w-20" />
</div>
Expand Down Expand Up @@ -167,20 +162,13 @@ export default function ViewPage({
if (emailProtected || linkPassword) {
return (
<>
<Head>
<meta
property="og:url"
key="og-url"
content={`https://www.papermark.io/view/${link.id}`}
/>
</Head>
{enableCustomMetatag ? (
<CustomMetatag
title={metaTitle}
description={metaDescription}
imageUrl={metaImage}
/>
) : null}
<CustomMetatag
enableBranding={enableCustomMetatag ?? false}
title={metaTitle ?? link.document.name}
description={metaDescription}
imageUrl={metaImage}
url={`https://www.papermark.io/view/${router.query.linkId}`}
/>
<DocumentView
link={link}
userEmail={userEmail}
Expand All @@ -198,20 +186,13 @@ export default function ViewPage({

return (
<>
<Head>
<meta
property="og:url"
key="og-url"
content={`https://www.papermark.io/view/${link.id}`}
/>
</Head>
{enableCustomMetatag ? (
<CustomMetatag
title={metaTitle}
description={metaDescription}
imageUrl={metaImage}
/>
) : null}
<CustomMetatag
enableBranding={enableCustomMetatag ?? false}
title={metaTitle ?? link.document.name}
description={metaDescription}
imageUrl={metaImage}
url={`https://www.papermark.io/view/${router.query.linkId}`}
/>
<DocumentView
link={link}
userEmail={userEmail}
Expand Down
63 changes: 21 additions & 42 deletions pages/view/d/[linkId]/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,20 +131,13 @@ export default function ViewPage({
if (!link || status === "loading" || router.isFallback) {
return (
<>
<Head>
<meta
property="og:url"
key="og-url"
content={`https://www.papermark.io/view/d/${router.query.linkId}`}
/>
</Head>
{meta && meta.enableCustomMetatag ? (
<CustomMetatag
title={meta.metaTitle}
description={meta.metaDescription}
imageUrl={meta.metaImage}
/>
) : null}
<CustomMetatag
enableBranding={meta?.enableCustomMetatag ?? false}
title={meta?.metaTitle ?? link.dataroom.name}
description={meta?.metaDescription ?? null}
imageUrl={meta?.metaImage ?? null}
url={`https://www.papermark.io/view/d/${router.query.linkId}`}
/>
<div className="h-screen flex items-center justify-center">
<LoadingSpinner className="h-20 w-20" />
</div>
Expand Down Expand Up @@ -180,20 +173,13 @@ export default function ViewPage({
if (emailProtected || linkPassword) {
return (
<>
<Head>
<meta
property="og:url"
key="og-url"
content={`https://www.papermark.io/view/d/${link.id}`}
/>
</Head>
{enableCustomMetatag ? (
<CustomMetatag
title={metaTitle}
description={metaDescription}
imageUrl={metaImage}
/>
) : null}
<CustomMetatag
enableBranding={enableCustomMetatag ?? false}
title={metaTitle}
description={metaDescription}
imageUrl={metaImage}
url={`https://www.papermark.io/view/d/${router.query.linkId}`}
/>
<DataroomView
link={link}
userEmail={verifiedEmail ?? userEmail}
Expand All @@ -209,20 +195,13 @@ export default function ViewPage({

return (
<>
<Head>
<meta
property="og:url"
key="og-url"
content={`https://www.papermark.io/view/d/${link.id}`}
/>
</Head>
{enableCustomMetatag ? (
<CustomMetatag
title={metaTitle}
description={metaDescription}
imageUrl={metaImage}
/>
) : null}
<CustomMetatag
enableBranding={enableCustomMetatag ?? false}
title={metaTitle}
description={metaDescription}
imageUrl={metaImage}
url={`https://www.papermark.io/view/d/${router.query.linkId}`}
/>
<DataroomView
link={link}
userEmail={userEmail}
Expand Down
Loading