docs: add og image

Author: HiDeoo

docs/astro.config.ts

@@ -1,13 +1,31 @@
 import starlight from '@astrojs/starlight'
 import { defineConfig } from 'astro/config'
 
+const site =
+  process.env['VERCEL_ENV'] !== 'production' && process.env['VERCEL_URL']
+    ? `https://${process.env['VERCEL_URL']}`
+    : 'https://starlight-typedoc.vercel.app/'
+
 export default defineConfig({
   integrations: [
     starlight({
       customCss: ['./src/styles/custom.css'],
       editLink: {
         baseUrl: 'https://github.com/HiDeoo/starlight-typedoc/edit/main/docs/',
       },
+      head: [
+        {
+          tag: 'meta',
+          attrs: { property: 'og:image', content: new URL('og.jpg', site).href },
+        },
+        {
+          tag: 'meta',
+          attrs: {
+            property: 'og:image:alt',
+            content: 'Starlight plugin to generate documentation from TypeScript using TypeDoc.',
+          },
+        },
+      ],
       sidebar: [
         {
           label: 'Start Here',
@@ -39,4 +57,5 @@ export default defineConfig({
       title: 'Starlight TypeDoc',
     }),
   ],
+  site,
 })

docs/public/og.jpg

@@ -2,13 +2,31 @@ import starlight from '@astrojs/starlight'
 import { defineConfig } from 'astro/config'
 import starlightTypeDoc, { typeDocSidebarGroup } from 'starlight-typedoc'
 
+const site =
+  process.env['VERCEL_ENV'] !== 'production' && process.env['VERCEL_URL']
+    ? `https://${process.env['VERCEL_URL']}`
+    : 'https://starlight-typedoc-example.vercel.app/'
+
 export default defineConfig({
   integrations: [
     starlight({
       customCss: ['./src/styles/custom.css'],
       editLink: {
         baseUrl: 'https://github.com/HiDeoo/starlight-typedoc/edit/main/example/',
       },
+      head: [
+        {
+          tag: 'meta',
+          attrs: { property: 'og:image', content: new URL('og.jpg', site).href },
+        },
+        {
+          tag: 'meta',
+          attrs: {
+            property: 'og:image:alt',
+            content: 'Starlight plugin to generate documentation from TypeScript using TypeDoc.',
+          },
+        },
+      ],
       plugins: [
         starlightTypeDoc({
           entryPoints: ['../fixtures/basics/src/index.ts'],