From 3b292f000ec567505566d4a4884cfc92cbaebc2e Mon Sep 17 00:00:00 2001 From: HiDeoo <494699+HiDeoo@users.noreply.github.com> Date: Mon, 2 Oct 2023 15:38:48 +0200 Subject: [PATCH] feat: add telegram icon --- .changeset/slimy-books-travel.md | 5 +++++ docs/src/content/docs/guides/customization.mdx | 2 +- docs/src/content/docs/reference/configuration.md | 2 +- packages/starlight/components/Icons.ts | 2 ++ packages/starlight/components/SocialIcons.astro | 1 + packages/starlight/utils/user-config.ts | 1 + 6 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 .changeset/slimy-books-travel.md diff --git a/.changeset/slimy-books-travel.md b/.changeset/slimy-books-travel.md new file mode 100644 index 0000000000..810b6f5805 --- /dev/null +++ b/.changeset/slimy-books-travel.md @@ -0,0 +1,5 @@ +--- +'@astrojs/starlight': patch +--- + +Add Telegram icon diff --git a/docs/src/content/docs/guides/customization.mdx b/docs/src/content/docs/guides/customization.mdx index e605372cdb..981adbdbe6 100644 --- a/docs/src/content/docs/guides/customization.mdx +++ b/docs/src/content/docs/guides/customization.mdx @@ -191,7 +191,7 @@ defineConfig({ Starlight has built-in support for adding links to your social media accounts to the site header via the [`social`](/reference/configuration/#social) option in the Starlight integration. -Currently, links to Bitbucket, Codeberg, CodePen, Discord, GitHub, GitLab, Gitter, Instagram, LinkedIn, Mastodon, Microsoft Teams, Stack Overflow, Threads, Twitch, Twitter, and Youtube are supported. +Currently, links to Bitbucket, Codeberg, CodePen, Discord, GitHub, GitLab, Gitter, Instagram, LinkedIn, Mastodon, Microsoft Teams, Stack Overflow, Telegram, Threads, Twitch, Twitter, and Youtube are supported. Let us know on GitHub or Discord if you need support for another service! ```js diff --git a/docs/src/content/docs/reference/configuration.md b/docs/src/content/docs/reference/configuration.md index 19c877db07..0929e28b89 100644 --- a/docs/src/content/docs/reference/configuration.md +++ b/docs/src/content/docs/reference/configuration.md @@ -307,7 +307,7 @@ The default locale will be used to provide fallback content where translations a ### `social` -**type:** `Partial>` +**type:** `Partial>` Optional details about the social media accounts for this site. Adding any of these will display them as icon links in the site header. diff --git a/packages/starlight/components/Icons.ts b/packages/starlight/components/Icons.ts index 68f1632fa4..8b18bb793d 100644 --- a/packages/starlight/components/Icons.ts +++ b/packages/starlight/components/Icons.ts @@ -86,4 +86,6 @@ export const Icons = { '', stackOverflow: '', + telegram: + '', }; diff --git a/packages/starlight/components/SocialIcons.astro b/packages/starlight/components/SocialIcons.astro index 2a42e71f79..38c9ec8933 100644 --- a/packages/starlight/components/SocialIcons.astro +++ b/packages/starlight/components/SocialIcons.astro @@ -21,6 +21,7 @@ const labels: Record = { microsoftTeams: 'Microsoft Teams', instagram: 'Instagram', stackOverflow: 'Stack Overflow', + telegram: 'Telegram', }; const links = Object.entries(config.social || {}).filter(([, url]) => Boolean(url)) as [ diff --git a/packages/starlight/utils/user-config.ts b/packages/starlight/utils/user-config.ts index dcc69ee439..fa27778ccc 100644 --- a/packages/starlight/utils/user-config.ts +++ b/packages/starlight/utils/user-config.ts @@ -152,6 +152,7 @@ const UserConfigSchema = z.object({ 'microsoftTeams', 'instagram', 'stackOverflow', + 'telegram', ]), // Link to the respective social profile for this site z.string().url()