diff --git a/docs/astro.config.ts b/docs/astro.config.ts
index 919abaf..1e5f142 100644
--- a/docs/astro.config.ts
+++ b/docs/astro.config.ts
@@ -1,6 +1,11 @@
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({
@@ -8,6 +13,19 @@ export default defineConfig({
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,
})
diff --git a/docs/public/og.jpg b/docs/public/og.jpg
new file mode 100644
index 0000000..998470d
Binary files /dev/null and b/docs/public/og.jpg differ
diff --git a/example/astro.config.ts b/example/astro.config.ts
index 273d533..e7e279c 100644
--- a/example/astro.config.ts
+++ b/example/astro.config.ts
@@ -2,6 +2,11 @@ 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({
@@ -9,6 +14,19 @@ export default defineConfig({
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'],
diff --git a/example/public/favicon.svg b/example/public/favicon.svg
index 707e172..7a07474 100644
--- a/example/public/favicon.svg
+++ b/example/public/favicon.svg
@@ -1 +1 @@
-
+
diff --git a/example/public/og.jpg b/example/public/og.jpg
new file mode 100644
index 0000000..998470d
Binary files /dev/null and b/example/public/og.jpg differ