openclaw/gitcrawl
openclaw/gitcrawl
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases 7 Wiki Activity

docs: add social card metadata

Browse Source
This commit is contained in:
Peter Steinberger 2026-05-05 06:55:30 +01:00
parent 14c02b5510
commit 6adb810aa8
No known key found for this signature in database
3 changed files with 112 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/social-card.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 185 KiB

75
docs/social-card.svg Normal file
View File

@ -0,0 +1,75 @@
<svg xmlns="http://www.w3.org/2000/svg" width="1200" height="630" viewBox="0 0 1200 630" role="img" aria-labelledby="title desc">
<title id="title">gitcrawl social card</title>
<desc id="desc">Local-first GitHub issue and pull request crawler for maintainer triage.</desc>
<defs>
<linearGradient id="bg" x1="0" y1="0" x2="1" y2="1">
<stop offset="0" stop-color="#f8fafc"/>
<stop offset="0.48" stop-color="#eef6ff"/>
<stop offset="1" stop-color="#f5f7fb"/>
</linearGradient>
<linearGradient id="panel" x1="0" y1="0" x2="1" y2="1">
<stop offset="0" stop-color="#111827"/>
<stop offset="1" stop-color="#0b1020"/>
</linearGradient>
<linearGradient id="accent" x1="0" y1="0" x2="1" y2="1">
<stop offset="0" stop-color="#2563eb"/>
<stop offset="1" stop-color="#14b8a6"/>
</linearGradient>
<filter id="shadow" x="-10%" y="-10%" width="120%" height="130%">
<feDropShadow dx="0" dy="22" stdDeviation="22" flood-color="#0f172a" flood-opacity="0.18"/>
</filter>
</defs>
<rect width="1200" height="630" fill="url(#bg)"/>
<path d="M76 512C201 462 311 473 421 545C531 617 681 600 804 529C943 449 1034 456 1128 507V630H76Z" fill="#e1eefb"/>
<path d="M910 64h190v10H910zM910 94h144v10H910zM910 124h166v10H910z" fill="#d6e2f0"/>
<g transform="translate(76 72)">
<rect x="0" y="0" width="118" height="118" rx="26" fill="#0f1115"/>
<circle cx="38" cy="38" r="9" fill="#60a5fa"/>
<circle cx="38" cy="80" r="9" fill="#2dd4bf"/>
<circle cx="80" cy="59" r="9" fill="#93c5fd"/>
<path d="M38 47v24M46 41c12 6 20 10 34 17M46 77c12-6 20-10 34-17" stroke="#c7f9ff" stroke-width="6" stroke-linecap="round" fill="none"/>
</g>
<g transform="translate(76 232)">
<text x="0" y="0" fill="#0f172a" font-family="Inter, -apple-system, BlinkMacSystemFont, Segoe UI, sans-serif" font-size="88" font-weight="800" letter-spacing="0">gitcrawl</text>
<text x="3" y="68" fill="#334155" font-family="Inter, -apple-system, BlinkMacSystemFont, Segoe UI, sans-serif" font-size="32" font-weight="600" letter-spacing="0">Local-first GitHub triage.</text>
<text x="3" y="121" fill="#64748b" font-family="Inter, -apple-system, BlinkMacSystemFont, Segoe UI, sans-serif" font-size="25" font-weight="500" letter-spacing="0">Search locally. Cache gh reads.</text>
<text x="3" y="159" fill="#64748b" font-family="Inter, -apple-system, BlinkMacSystemFont, Segoe UI, sans-serif" font-size="25" font-weight="500" letter-spacing="0">Save the rate limit.</text>
</g>
<g transform="translate(76 486)">
<rect x="0" y="0" width="196" height="44" rx="10" fill="#0f172a"/>
<text x="22" y="29" fill="#e0f2fe" font-family="JetBrains Mono, SFMono-Regular, Menlo, monospace" font-size="19" font-weight="600" letter-spacing="0">gitcrawl.sh</text>
<rect x="216" y="0" width="210" height="44" rx="10" fill="#ffffff" stroke="#cbd5e1"/>
<text x="238" y="29" fill="#334155" font-family="JetBrains Mono, SFMono-Regular, Menlo, monospace" font-size="18" font-weight="600" letter-spacing="0">gh xcache stats</text>
</g>
<g transform="translate(640 118)" filter="url(#shadow)">
<rect x="0" y="0" width="474" height="338" rx="22" fill="url(#panel)"/>
<rect x="0" y="0" width="474" height="46" rx="22" fill="#182033"/>
<path d="M0 28h474v18H0z" fill="#182033"/>
<circle cx="28" cy="23" r="6" fill="#f87171"/>
<circle cx="49" cy="23" r="6" fill="#facc15"/>
<circle cx="70" cy="23" r="6" fill="#34d399"/>
<text x="30" y="86" fill="#93c5fd" font-family="JetBrains Mono, SFMono-Regular, Menlo, monospace" font-size="19" font-weight="600" letter-spacing="0">$ gitcrawl search prs cache</text>
<text x="30" y="126" fill="#e5e7eb" font-family="JetBrains Mono, SFMono-Regular, Menlo, monospace" font-size="18" letter-spacing="0">#77622 hydrated PR details</text>
<text x="30" y="160" fill="#e5e7eb" font-family="JetBrains Mono, SFMono-Regular, Menlo, monospace" font-size="18" letter-spacing="0">#77481 Actions log cache</text>
<text x="30" y="194" fill="#e5e7eb" font-family="JetBrains Mono, SFMono-Regular, Menlo, monospace" font-size="18" letter-spacing="0">#77109 local issue thread</text>
<rect x="30" y="228" width="414" height="70" rx="14" fill="#0b1326" stroke="#334155"/>
<text x="54" y="260" fill="#a7f3d0" font-family="JetBrains Mono, SFMono-Regular, Menlo, monospace" font-size="16" letter-spacing="0">local_hits 112</text>
<text x="54" y="284" fill="#bfdbfe" font-family="JetBrains Mono, SFMono-Regular, Menlo, monospace" font-size="16" letter-spacing="0">fallback_hits 70</text>
<path d="M272 264h112" stroke="url(#accent)" stroke-width="10" stroke-linecap="round"/>
</g>
<g transform="translate(858 450)">
<path d="M40 32C92 0 145 6 190 40M40 32c51 55 105 70 178 42M190 40c19 13 29 24 28 34" stroke="#2563eb" stroke-width="5" stroke-linecap="round" fill="none"/>
<circle cx="40" cy="32" r="15" fill="#2563eb"/>
<circle cx="190" cy="40" r="15" fill="#14b8a6"/>
<circle cx="218" cy="74" r="15" fill="#38bdf8"/>
<circle cx="112" cy="86" r="10" fill="#64748b"/>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 5.0 KiB

37
scripts/build-docs-site.mjs
View File

@ -10,6 +10,7 @@ const outDir = path.join(root, "dist", "docs-site");
const repoBase = "https://github.com/openclaw/gitcrawl";
const repoEditBase = `${repoBase}/edit/main/docs`;
const cname = readCname();
const siteBase = cname ? `https://${cname}` : "";
const sections = [
["Start", ["index.md", "installation.md", "quickstart.md", "concepts.md"]],
@ -63,6 +64,8 @@ for (const page of pages) {
}
fs.writeFileSync(path.join(outDir, "favicon.svg"), faviconSvg(), "utf8");
copyStaticAsset("social-card.svg");
copyStaticAsset("social-card.png");
fs.writeFileSync(path.join(outDir, ".nojekyll"), "", "utf8");
if (cname) fs.writeFileSync(path.join(outDir, "CNAME"), cname, "utf8");
validateLinks(outDir);
@ -75,6 +78,11 @@ function readCname() {
return "";
}
function copyStaticAsset(name) {
const source = path.join(docsDir, name);
if (fs.existsSync(source)) fs.copyFileSync(source, path.join(outDir, name));
}
function parseFrontmatter(raw) {
const match = raw.match(/^---\n([\s\S]*?)\n---\n?/);
if (!match) return { frontmatter: {}, body: raw };
@ -360,6 +368,23 @@ function layout({ page, html, toc, prev, next, sectionName }) {
const articleClass = isHome ? "doc doc-home" : "doc";
const tocBlock = isHome ? "" : toc;
const titleSuffix = isHome ? "gitcrawl" : `${escapeHtml(page.title)} — gitcrawl`;
const canonicalUrl = pageCanonicalUrl(page);
const socialImage = siteBase ? `${siteBase}/social-card.png` : `${rootPrefix}social-card.png`;
const socialMeta = [
["link", "rel", "canonical", "href", canonicalUrl],
["meta", "property", "og:type", "content", "website"],
["meta", "property", "og:site_name", "content", "gitcrawl"],
["meta", "property", "og:title", "content", titleSuffix],
["meta", "property", "og:description", "content", "Local-first GitHub issue and pull request crawler for maintainer triage."],
["meta", "property", "og:url", "content", canonicalUrl],
["meta", "property", "og:image", "content", socialImage],
["meta", "property", "og:image:width", "content", "1200"],
["meta", "property", "og:image:height", "content", "630"],
["meta", "name", "twitter:card", "content", "summary_large_image"],
["meta", "name", "twitter:title", "content", titleSuffix],
["meta", "name", "twitter:description", "content", "Local-first GitHub issue and pull request crawler for maintainer triage."],
["meta", "name", "twitter:image", "content", socialImage],
].map(tagHtml).join("\n ");
return `<!doctype html>
<html lang="en">
<head>
@ -367,6 +392,7 @@ function layout({ page, html, toc, prev, next, sectionName }) {
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>${titleSuffix}</title>
<meta name="description" content="Local-first GitHub issue and pull request crawler for maintainer triage.">
${socialMeta}
<link rel="icon" href="${rootPrefix}favicon.svg" type="image/svg+xml">
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
@ -399,6 +425,17 @@ function layout({ page, html, toc, prev, next, sectionName }) {
</html>`;
}
function pageCanonicalUrl(page) {
if (!siteBase) return page.outRel;
if (page.outRel === "index.html") return `${siteBase}/`;
const rel = page.outRel.endsWith("/index.html") ? page.outRel.slice(0, -"index.html".length) : page.outRel;
return `${siteBase}/${rel}`;
}
function tagHtml([tag, k1, v1, k2, v2]) {
return tag === "link" ? `<link ${k1}="${v1}" ${k2}="${escapeAttr(v2)}">` : `<meta ${k1}="${v1}" ${k2}="${escapeAttr(v2)}">`;
}
function standardHero(page, sectionName, editUrl) {
return `<header class="hero">
<div class="hero-text">