Skip to content

seo: add appropriate og tags for link sharing #460

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 5 commits into from
Aug 20, 2025
Merged

seo: add appropriate og tags for link sharing #460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
21ac89f
Initial plan
Copilot Aug 20, 2025
ee2926a
Changes before error encountered
Copilot Aug 20, 2025
18487e1
push
Boshen Aug 20, 2025
d39680a
push
Boshen Aug 20, 2025
0880c63
fmt
Boshen Aug 20, 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
33 changes: 28 additions & 5 deletions .vitepress/config/shared.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ const head: HeadConfig[] = [
],
// Open Graph
["meta", { property: "og:site_name", content: "Oxc" }],
["meta", { property: "og:url", content: "https://github.com/oxc-project" }],
[
"meta",
{
Expand Down Expand Up @@ -65,11 +64,11 @@ export const sharedConfig = defineConfig({
base: "/",
head,
lastUpdated: false,
transformHead: ({ pageData }) => {
const head: HeadConfig[] = [];
transformPageData(pageData) {
pageData.frontmatter.head ??= [];

if (pageData.frontmatter.canonical) {
head.push([
pageData.frontmatter.head.push([
"link",
{
rel: "canonical",
Expand All @@ -78,7 +77,31 @@ export const sharedConfig = defineConfig({
]);
}

return head;
// Add page-specific Open Graph and Twitter meta tags
const title = pageData.frontmatter.title || pageData.title;
const description = pageData.frontmatter.description || pageData.description
|| "A collection of high-performance JavaScript tools written in Rust";

// Construct the canonical URL for the page
let url = "https://oxc.rs";
if (pageData.relativePath !== "index.md") {
const path = pageData.relativePath.replace(/\.md$/, ".html").replace(/\/index\.html$/, "/");
if (path !== "index.html") {
url += "/" + path.replace(/^\/+/, "");
}
}

if (title) {
pageData.frontmatter.head.push(["meta", { property: "og:title", content: title }]);
pageData.frontmatter.head.push(["meta", { name: "twitter:title", content: title }]);
}

if (description) {
pageData.frontmatter.head.push(["meta", { property: "og:description", content: description }]);
pageData.frontmatter.head.push(["meta", { name: "twitter:description", content: description }]);
}

pageData.frontmatter.head.push(["meta", { property: "og:url", content: url }]);
},
themeConfig: {
siteTitle: "Oxc",
Expand Down
Loading