Skip to content

[add] Enhance PageHead component with Open Graph and Twitter meta tags; [add] robots.txt and sitemap.xml for SEO optimization #75

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

Merged
merged 3 commits into from
May 22, 2025
Merged

[add] Enhance PageHead component with Open Graph and Twitter meta tags; [add] robots.txt and sitemap.xml for SEO optimization #75

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
afa1675
[add] Enhance PageHead component with Open Graph and Twitter meta tag…
wangrunlin Apr 6, 2025
e7ecc64
Merge remote-tracking branch 'origin/main' into seo
wangrunlin May 22, 2025
9832b6a
[refactor] Update PageHead component to use Partial type for props; […
wangrunlin May 22, 2025
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
52 changes: 40 additions & 12 deletions components/PageHead.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,47 @@
import Head from 'next/head';
import type { FC, PropsWithChildren } from 'react';

import { Name, Summary } from '../models/configuration';
import { Name, SiteUrl, Summary } from '../models/configuration';

export type PageHeadProps = PropsWithChildren<{
title?: string;
description?: string;
}>;
export type PageHeadProps = PropsWithChildren<
Partial<Record<'title' | 'description' | 'ogImage' | 'type' | 'url', string>>
>;

export const PageHead: FC<PageHeadProps> = ({ title, description = Summary, children }) => (
<Head>
<title>{(title ? `${title} - ` : '') + Name}</title>
export const PageHead: FC<PageHeadProps> = ({
title,
description = Summary,
ogImage = 'https://github.com/idea2app.png',
type = 'website',
url = SiteUrl,
children,
}) => {
const fullTitle = (title ? `${title} - ` : '') + Name;
const fullUrl = url.startsWith('/') ? `${SiteUrl}${url}` : url;

{description && <meta name="description" content={description} />}
return (
<Head>
{/* 基础 meta 标签 */}
<title>{fullTitle}</title>
<meta name="description" content={description} />

{children}
</Head>
);
{/* Open Graph */}
<meta property="og:title" content={fullTitle} />
<meta property="og:description" content={description} />
<meta property="og:type" content={type} />
<meta property="og:image" content={ogImage} />
<meta property="og:url" content={fullUrl} />
<meta property="og:site_name" content={Name} />

{/* Twitter */}
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content={fullTitle} />
<meta name="twitter:description" content={description} />
<meta name="twitter:image" content={ogImage} />

{/* 规范链接 */}
<link rel="canonical" href={fullUrl} />

{children}
</Head>
);
};
3 changes: 2 additions & 1 deletion models/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
export const Name = process.env.NEXT_PUBLIC_SITE_NAME,
Summary = process.env.NEXT_PUBLIC_SITE_SUMMARY,
DefaultImage = process.env.NEXT_PUBLIC_LOGO || '/og.png';
DefaultImage = process.env.NEXT_PUBLIC_LOGO || '/idea2app.svg',
SiteUrl = `https://${process.env.VERCEL_URL || 'idea2.app'}`;

export const isServer = () => typeof window === 'undefined';

Expand Down
17 changes: 14 additions & 3 deletions pages/_document.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import InitColorSchemeScript from '@mui/material/InitColorSchemeScript';
import Document, { DocumentContext, Head, Html, Main, NextScript } from 'next/document';
import Script from 'next/script';

import { DefaultImage } from '../models/configuration';
import { DefaultImage, Name, SiteUrl } from '../models/configuration';
import { LanguageCode, parseSSRContext } from '../models/Translation';

/**
Expand All @@ -12,8 +12,18 @@ import { LanguageCode, parseSSRContext } from '../models/Translation';
const siteNameJsonLd = {
'@context': 'https://schema.org',
'@type': 'WebSite',
name: 'Ameliorate',
url: 'https://idea2.app/',
name: Name,
url: SiteUrl,
};

const organizationJsonLd = {
'@context': 'https://schema.org',
'@type': 'Organization',
name: Name,
url: SiteUrl,
logo: DefaultImage,
sameAs: ['https://github.com/idea2app'],
email: '[email protected]',
};

interface CustomDocumentProps {
Expand Down Expand Up @@ -59,6 +69,7 @@ export default class CustomDocument extends Document<CustomDocumentProps> {
href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0&display=swap"
/>
<script type="application/ld+json">{JSON.stringify(siteNameJsonLd)}</script>
<script type="application/ld+json">{JSON.stringify(organizationJsonLd)}</script>
</Head>

<body>
Expand Down
4 changes: 4 additions & 0 deletions public/robots.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
User-agent: *
Allow: /

Sitemap: https://idea2.app/sitemap.xml
28 changes: 28 additions & 0 deletions public/sitemap.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://idea2.app/</loc>
<changefreq>daily</changefreq>
<priority>1.0</priority>
</url>
<url>
<loc>https://idea2.app/project</loc>
<changefreq>weekly</changefreq>
<priority>0.8</priority>
</url>
<url>
<loc>https://idea2.app/requirement</loc>
<changefreq>weekly</changefreq>
<priority>0.8</priority>
</url>
<url>
<loc>https://idea2.app/member</loc>
<changefreq>weekly</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://idea2.app/open-source</loc>
<changefreq>weekly</changefreq>
<priority>0.7</priority>
</url>
</urlset>