From 0236f9bd0aa8a57c68fc0c0e17aa363a355884dc Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Sat, 9 Jul 2022 13:07:17 +0530 Subject: [PATCH] docs: update social link interface --- docs/config/theme-configs.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/config/theme-configs.md b/docs/config/theme-configs.md index b1b63151..f0abc6fb 100644 --- a/docs/config/theme-configs.md +++ b/docs/config/theme-configs.md @@ -130,7 +130,6 @@ interface SidebarItem { } ``` - ## outlineTitle - Type: `string` @@ -148,7 +147,7 @@ export default { ## socialLinks -- Type: `SocialLink` +- Type: `SocialLink[]` You may define this option to show your social account links with icons in nav. @@ -158,7 +157,14 @@ export default { socialLinks: [ { icon: 'github', link: 'https://github.com/vuejs/vitepress' }, { icon: 'twitter', link: '...' }, - { icon: 'discord', link: '...' } + // You can also add custom icons by passing SVG as string: + // [Pro Tip] You can get icon from https://simpleicons.org/ for many popular brands + { + icon: { + svg: 'Dribbble' + }, + link: '...' + } ] } } @@ -179,6 +185,7 @@ type SocialLinkIcon = | 'slack' | 'twitter' | 'youtube' + | { svg: string } ``` ## footer