feat: on demand social icons (#4339)

vuejs · Nov 4, 2024 · 05f2f0d · 05f2f0d
1 parent 602ae7b
commit 05f2f0d
Show file tree

Hide file tree

Showing 15 changed files with 170 additions and 146 deletions.
diff --git a/docs/en/reference/default-theme-config.md b/docs/en/reference/default-theme-config.md
@@ -228,6 +228,7 @@ You may define this option to show your social account links with icons in nav.
 export default {
   themeConfig: {
     socialLinks: [
+      // You can add any icon from simple-icons (https://simpleicons.org/):
       { icon: 'github', link: 'https://github.com/vuejs/vitepress' },
       { icon: 'twitter', link: '...' },
       // You can also add custom icons by passing SVG as string:
@@ -246,24 +247,10 @@ export default {
 
 ```ts
 interface SocialLink {
-  icon: SocialLinkIcon
+  icon: string | { svg: string }
   link: string
   ariaLabel?: string
 }
-
-type SocialLinkIcon =
-  | 'discord'
-  | 'facebook'
-  | 'github'
-  | 'instagram'
-  | 'linkedin'
-  | 'mastodon'
-  | 'npm'
-  | 'slack'
-  | 'twitter'
-  | 'x'
-  | 'youtube'
-  | { svg: string }
 ```
 
 ## footer

diff --git a/docs/es/reference/default-theme-config.md b/docs/es/reference/default-theme-config.md
@@ -233,24 +233,10 @@ export default {
 
 ```ts
 interface SocialLink {
-  icon: SocialLinkIcon
+  icon: string | { svg: string }
   link: string
   ariaLabel?: string
 }
-
-type SocialLinkIcon =
-  | 'discord'
-  | 'facebook'
-  | 'github'
-  | 'instagram'
-  | 'linkedin'
-  | 'mastodon'
-  | 'npm'
-  | 'slack'
-  | 'twitter'
-  | 'x'
-  | 'youtube'
-  | { svg: string }
 ```
 
 ## footer

diff --git a/docs/ko/reference/default-theme-config.md b/docs/ko/reference/default-theme-config.md
@@ -246,24 +246,10 @@ export default {
 
 ```ts
 interface SocialLink {
-  icon: SocialLinkIcon
+  icon: string | { svg: string }
   link: string
   ariaLabel?: string
 }
-
-type SocialLinkIcon =
-  | 'discord'
-  | 'facebook'
-  | 'github'
-  | 'instagram'
-  | 'linkedin'
-  | 'mastodon'
-  | 'npm'
-  | 'slack'
-  | 'twitter'
-  | 'x'
-  | 'youtube'
-  | { svg: string }
 ```
 
 ## footer

diff --git a/docs/pt/reference/default-theme-config.md b/docs/pt/reference/default-theme-config.md
@@ -233,24 +233,10 @@ export default {
 
 ```ts
 interface SocialLink {
-  icon: SocialLinkIcon
+  icon: string | { svg: string }
   link: string
   ariaLabel?: string
 }
-
-type SocialLinkIcon =
-  | 'discord'
-  | 'facebook'
-  | 'github'
-  | 'instagram'
-  | 'linkedin'
-  | 'mastodon'
-  | 'npm'
-  | 'slack'
-  | 'twitter'
-  | 'x'
-  | 'youtube'
-  | { svg: string }
 ```
 
 ## footer

diff --git a/docs/ru/reference/default-theme-config.md b/docs/ru/reference/default-theme-config.md
@@ -233,24 +233,10 @@ export default {
 
 ```ts
 interface SocialLink {
-  icon: SocialLinkIcon
+  icon: string | { svg: string }
   link: string
   ariaLabel?: string
 }
-
-type SocialLinkIcon =
-  | 'discord'
-  | 'facebook'
-  | 'github'
-  | 'instagram'
-  | 'linkedin'
-  | 'mastodon'
-  | 'npm'
-  | 'slack'
-  | 'twitter'
-  | 'x'
-  | 'youtube'
-  | { svg: string }
 ```
 
 ## footer {#footer}

diff --git a/docs/zh/reference/default-theme-config.md b/docs/zh/reference/default-theme-config.md
@@ -233,24 +233,10 @@ export default {
 
 ```ts
 interface SocialLink {
-  icon: SocialLinkIcon
+  icon: string | { svg: string }
   link: string
   ariaLabel?: string
 }
-
-type SocialLinkIcon =
-  | 'discord'
-  | 'facebook'
-  | 'github'
-  | 'instagram'
-  | 'linkedin'
-  | 'mastodon'
-  | 'npm'
-  | 'slack'
-  | 'twitter'
-  | 'x'
-  | 'youtube'
-  | { svg: string }
 ```
 
 ## footer

diff --git a/package.json b/package.json
@@ -100,6 +100,7 @@
   "dependencies": {
     "@docsearch/css": "^3.6.2",
     "@docsearch/js": "^3.6.2",
+    "@iconify-json/simple-icons": "^1.2.10",
     "@shikijs/core": "^1.22.2",
     "@shikijs/transformers": "^1.22.2",
     "@shikijs/types": "^1.22.2",
@@ -118,6 +119,7 @@
   },
   "devDependencies": {
     "@clack/prompts": "^0.7.0",
+    "@iconify/utils": "^2.1.33",
     "@mdit-vue/plugin-component": "^2.1.3",
     "@mdit-vue/plugin-frontmatter": "^2.1.3",
     "@mdit-vue/plugin-headers": "^2.1.3",