Skip to content

feat: add SEO meta tags and social preview image to workshop docs site #2324

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
pelikhan merged 1 commit into from
Jul 29, 2026
+28 −1
Merged

feat: add SEO meta tags and social preview image to workshop docs site #2324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions scripts/build-docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ if (fs.existsSync(workshopImagesDir)) {
const faviconSrc = path.join(__dirname, 'static', 'favicon.svg');
fs.copyFileSync(faviconSrc, path.join(distDir, 'favicon.svg'));

// Copy social preview image
const ogImageSrc = path.join(__dirname, 'static', 'og-image.png');
fs.copyFileSync(ogImageSrc, path.join(distDir, 'og-image.png'));

// Copy theme chooser script
const docsThemeSrc = path.join(__dirname, 'static', 'docs-theme.js');
fs.copyFileSync(docsThemeSrc, path.join(distDir, 'docs-theme.js'));
Expand Down
25 changes: 24 additions & 1 deletion scripts/lib/page-template.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
'use strict';

// Generate the single-page workshop reader HTML.
const SITE_URL = 'https://githubnext.github.io/gh-aw-workshop';
const SITE_TITLE = 'GitHub Agentic Workflows Workshop';
const SITE_DESCRIPTION =
'A hands-on workshop that teaches you how to build GitHub Agentic Workflows with the gh-aw CLI. Go from zero to a working AI-powered automation in GitHub Actions.';
const OG_IMAGE_URL = `${SITE_URL}/og-image.png`;

function generatePage(htmlContent, workshopMenu) {
return `<!DOCTYPE html>
<html lang="en" data-color-mode="auto" data-light-theme="light" data-dark-theme="dark">
Expand All @@ -10,7 +16,24 @@ function generatePage(htmlContent, workshopMenu) {
<meta name="color-scheme" content="light dark">
<meta name="theme-color" content="#ffffff" media="(prefers-color-scheme: light)">
<meta name="theme-color" content="#0d1117" media="(prefers-color-scheme: dark)">
<title>GitHub Agentic Workflows Workshop</title>
<title>${SITE_TITLE}</title>
<meta name="description" content="${SITE_DESCRIPTION}">
<!-- Open Graph -->
<meta property="og:type" content="website">
<meta property="og:url" content="${SITE_URL}/">
<meta property="og:title" content="${SITE_TITLE}">
<meta property="og:description" content="${SITE_DESCRIPTION}">
<meta property="og:image" content="${OG_IMAGE_URL}">
<meta property="og:image:width" content="1200">
<meta property="og:image:height" content="630">
<meta property="og:image:alt" content="Mona's Agent Factory — GitHub Agentic Workflows Workshop">
<!-- Twitter / X Card -->
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="${SITE_TITLE}">
<meta name="twitter:description" content="${SITE_DESCRIPTION}">
<meta name="twitter:image" content="${OG_IMAGE_URL}">
<meta name="twitter:image:alt" content="Mona's Agent Factory — GitHub Agentic Workflows Workshop">
<link rel="canonical" href="${SITE_URL}/">
<link rel="icon" type="image/svg+xml" href="favicon.svg">
<link rel="stylesheet" href="mona-sans.css">
<link rel="stylesheet" href="primer.css">
Expand Down
Binary file added scripts/static/og-image.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.