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

refactor/feat: Add blog articles schema markup #9

Merged
merged 3 commits into from
Jun 6, 2024
Merged

refactor/feat: Add blog articles schema markup #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e8a7c2
refactor: page metadata headers readability
gmolki Jun 5, 2024
996c3ca
refactor: meta tags data fetching
gmolki Jun 6, 2024
afe4df8
feat: first version of article schema markup
gmolki Jun 6, 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
127 changes: 54 additions & 73 deletions src/pages/_pageMetadataHead.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { getFieldFromSources } from "@/utils/getFieldFromSources";
import { BuilderContent } from "@builder.io/sdk";
import Head from "next/head";

Expand All @@ -22,6 +23,7 @@ export type PageMetadataProps = {
canonicalUrl?: PageMetadataField;
openGraph?: PageOpenGraphProps | null;
twitter?: PageTwitterProps | null;
schemaMarkup?: object | null;
};

export const PageMetadataHead = ({
Expand All @@ -30,78 +32,57 @@ export const PageMetadataHead = ({
}: {
pageMetadata?: PageMetadataProps | null;
content: BuilderContent | null;
}) => (
<Head>
<title>{pageMetadata?.title || content?.data?.metadata?.title}</title>
<meta
name="description"
content={
pageMetadata?.description || content?.data?.metadata?.description
}
/>
<link
rel="canonical"
href={pageMetadata?.canonicalUrl || content?.data?.metadata?.canonicalUrl}
/>
<meta
property="og:title"
content={
pageMetadata?.openGraph?.title ||
content?.data?.metadata?.openGraph?.title
}
/>
<meta
property="og:description"
content={
pageMetadata?.openGraph?.description ||
content?.data?.metadata?.openGraph?.description
}
/>
<meta
property="og:image"
content={
pageMetadata?.openGraph?.image ||
content?.data?.metadata?.openGraph?.image
}
/>
<meta
property="og:url"
content={
pageMetadata?.openGraph?.url || content?.data?.metadata?.openGraph?.url
}
/>
<meta
name="twitter:card"
content={
pageMetadata?.twitter?.card || content?.data?.metadata?.twitter?.card
}
/>
<meta
name="twitter:site"
content={
pageMetadata?.twitter?.site || content?.data?.metadata?.twitter?.site
}
/>
<meta
name="twitter:title"
content={
pageMetadata?.twitter?.title || content?.data?.metadata?.twitter?.title
}
/>
<meta
name="twitter:description"
content={
pageMetadata?.twitter?.description ||
content?.data?.metadata?.twitter?.description
}
/>
<meta
name="twitter:image"
content={
pageMetadata?.twitter?.image || content?.data?.metadata?.twitter?.image
}
/>
</Head>
);
}) => {
const contentPageMetadata = content?.data?.metadata ?? {};
const getMetaField = (keys: string[]) => {
return getFieldFromSources({
sourcesByPriority: [pageMetadata, contentPageMetadata],
keys,
});
};

const schemaMarkup = getMetaField(["schemaMarkup"]);

return (
<Head>
<title>{getMetaField(["title"])}</title>
<meta name="description" content={getMetaField(["description"])} />
<link rel="canonical" href={getMetaField(["canonicalUrl"])} />

{/* Open Graph */}
<meta
property="og:title"
content={getMetaField(["openGraph", "title"])}
/>
<meta
property="og:description"
content={getMetaField(["openGraph", "description"])}
/>
<meta
property="og:image"
content={getMetaField(["openGraph", "image"])}
/>
<meta property="og:url" content={getMetaField(["openGraph", "url"])} />

{/* Twitter */}
<meta name="twitter:title" content={getMetaField(["twitter", "title"])} />
<meta
name="twitter:description"
content={getMetaField(["twitter", "description"])}
/>
<meta name="twitter:card" content={getMetaField(["twitter", "card"])} />
<meta name="twitter:site" content={getMetaField(["twitter", "site"])} />
<meta name="twitter:image" content={getMetaField(["twitter", "image"])} />

{/* Schema.org */}
{schemaMarkup && (
<script
type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify(schemaMarkup) }}
/>
)}
</Head>
);
};

export default PageMetadataHead;
34 changes: 22 additions & 12 deletions src/pages/blog/articles/[blogArticle].tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,28 @@
import React from "react";
import { builder } from "@builder.io/react";
import { GetStaticProps, GetStaticPaths } from "next";
import DynamicPage, { DynamicPageProps } from "@/pages/_dynamicPage";
import { fetchBuilderData } from "@/utils/fetchBuilderData";
import { buildArticleSchemaMarkup } from "@/utils/blog/buildArticleSchemaMarkup";

const PAGE_MODEL = "blog-article";

export const getStaticProps: GetStaticProps = (async ({ params }) => {
const page = await builder
.get(PAGE_MODEL, {
const page = await fetchBuilderData("get", [
PAGE_MODEL,
{
userAttributes: {
urlPath: "/" + ((params?.page as string[])?.join("/") || ""),
urlPath: params?.blogArticle
? `/blog/articles/${params.blogArticle}`
: "",
},
})
.toPromise();
},
]);

const pageProps: DynamicPageProps = {
page: page || null,
pageMetadata: {
schemaMarkup: buildArticleSchemaMarkup(page),
},
};

return {
Expand All @@ -24,13 +31,16 @@ export const getStaticProps: GetStaticProps = (async ({ params }) => {
}) satisfies GetStaticProps;

export const getStaticPaths: GetStaticPaths = async () => {
const pages = await builder.getAll(PAGE_MODEL, {
fields: "data.url",
options: { noTargeting: true },
});
const pages = await fetchBuilderData("getAll", [
PAGE_MODEL,
{
fields: "data.url",
options: { noTargeting: true },
},
]);

const paths = pages
.map((page) => {
.map((page: any) => {
const urlPath = page.data?.url?.split("/").filter(Boolean);
if (urlPath && urlPath.length > 0) {
return {
Expand All @@ -40,7 +50,7 @@ export const getStaticPaths: GetStaticPaths = async () => {
return null;
})
.filter(
(path): path is { params: { blogArticle: string } } => path !== null
(path: any): path is { params: { blogArticle: string } } => path !== null
);

return {
Expand Down
48 changes: 48 additions & 0 deletions src/utils/blog/buildArticleSchemaMarkup.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { getFieldFromSources } from "../getFieldFromSources";

export const buildArticleSchemaMarkup = (page: any) => {
if (!page) return null;

const formatDate = (timestamp?: string) =>
timestamp ? new Date(timestamp).toISOString() : null;

const typeFromModel = (model: string) => {
switch (model) {
case "schema-org-person":
return "Person";
case "schema-org-organization":
return "Organization";
default:
return null;
}
};

const getField = (keys: string[]) =>
getFieldFromSources({ sourcesByPriority: [page], keys });

const dateModified = formatDate(getField(["lastUpdated"]));
const datePublished = formatDate(getField(["firstPublished"]));

return {
"@context": "https://schema.org",
"@type": "Article",
name: getField(["data", "title"]),
headline: getField(["data", "headline"]),
description: getField(["data", "description"]),
url: getField(["data", "metadata", "canonicalUrl"]),
mainEntityOfPage: getField(["data", "metadata", "canonicalUrl"]),
image: getField(["data", "featureImage"]),
thumbnailUrl: getField(["data", "thumbnailImage"]),
dateCreated: datePublished,
datePublished: datePublished,
dateModified: dateModified,
author: {
"@type": typeFromModel(page.data?.metadata?.author?.model),
...getField(["data", "metadata", "author", "value", "data"]),
},
publisher: {
"@type": typeFromModel(page.data?.metadata?.publisher?.model),
...getField(["data", "metadata", "publisher", "value", "data"]),
},
};
};
18 changes: 18 additions & 0 deletions src/utils/getFieldFromSources.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
interface GetMetdataFieldArgs {
sourcesByPriority: any[];
keys: string[];
}

type GetMetdataFieldResponse = any | null;

export const getFieldFromSources = ({
sourcesByPriority,
keys,
}: GetMetdataFieldArgs): GetMetdataFieldResponse => {
return sourcesByPriority?.reduce((result: any, source) => {
if (result != null) return result;

const value = keys.reduce((obj: any, key) => obj?.[key], source);
return value != null ? value : result;
}, null);
};
Loading