docs: update social link interface

pull/953/head
Divyansh Singh 3 years ago
parent e107e471ae
commit 0236f9bd0a

@ -130,7 +130,6 @@ interface SidebarItem {
} }
``` ```
## outlineTitle ## outlineTitle
- Type: `string` - Type: `string`
@ -148,7 +147,7 @@ export default {
## socialLinks ## socialLinks
- Type: `SocialLink` - Type: `SocialLink[]`
You may define this option to show your social account links with icons in nav. You may define this option to show your social account links with icons in nav.
@ -158,7 +157,14 @@ export default {
socialLinks: [ socialLinks: [
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }, { icon: 'github', link: 'https://github.com/vuejs/vitepress' },
{ icon: 'twitter', link: '...' }, { 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: '<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Dribbble</title><path d="M12...6.38z"/></svg>'
},
link: '...'
}
] ]
} }
} }
@ -179,6 +185,7 @@ type SocialLinkIcon =
| 'slack' | 'slack'
| 'twitter' | 'twitter'
| 'youtube' | 'youtube'
| { svg: string }
``` ```
## footer ## footer

Loading…
Cancel
Save