docs: add share image and favicon for the docs site

jimp-dev · Dec 26, 2024 · 05ae68d · 05ae68d
1 parent b6b0e41
commit 05ae68d
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 1 deletion.
diff --git a/packages/docs/astro.config.mjs b/packages/docs/astro.config.mjs
@@ -15,6 +15,10 @@ export default defineConfig({
       social: {
         github: "https://github.com/jimp-dev/jimp",
       },
+      favicon: "/favicon.png",
+      components: {
+        Head: "./src/overwrite-components/head.astro",
+      },
       sidebar: [
         {
           label: "Docs",

diff --git a/packages/docs/public/favicon.png b/packages/docs/public/favicon.png
diff --git a/packages/docs/public/favicon.svg b/packages/docs/public/favicon.svg
diff --git a/packages/docs/public/share-banner.png b/packages/docs/public/share-banner.png
diff --git a/packages/docs/src/overwrite-components/head.astro b/packages/docs/src/overwrite-components/head.astro
@@ -0,0 +1,11 @@
+---
+import type { Props } from "@astrojs/starlight/props";
+import Default from "@astrojs/starlight/components/Head.astro";
+---
+
+<Default {...Astro.props}>
+	<slot />
+</Default>
+<meta name="twitter:image" content="https://jimp-dev.github.io/jimp/share-banner.png">
+<meta name="twitter:card" content="summary_large_image">
+<meta property="og:image" content="https://jimp-dev.github.io/jimp/share-banner.png">