The social parameter is a set of key value pairs of social links that mapping from platform to their user identifier. It supports many popular social platforms, such as Twitter, Facebook, Reddit, GitHub. This article lists all supported platforms and how to use them.

Usage

There are three places you can put social links to: top app bar, Author Widget and footer.

Top App Bar

params.toml

1[topAppBar]
2  [topAppBar.social]
3    github = 'foobar'
toml

params.yaml

1topAppBar:
2  social:
3    github: foobar
yaml

params.json

1{
2   "topAppBar": {
3      "social": {
4         "github": "foobar"
5      }
6   }
7}
json

Author Widget

Set up social links by editing a file config/_default/params.toml with the following content:

1[author.social]
2  email = "user@domain.tld"
3  github = "githubusername"
toml

Set up social links by putting the following content in config/_default/params.toml.

1[social]
2email = "user@domain.tld"
3github = "githubusername"
toml

Platforms

The value can be changed to a full URL if necessary.

PlatformUser Identifier
bibibiliBiliBili User ID
bitbucketBitbucket Workspace ID
codebergCodeberg Username
discordDiscord Invite Code
discourseForum URL
dockerhubDocker Hub Username
emailEmail Address
facebookFacebook Username
facebookgroupFacebook Group Name
githubGitHub Username
gitlabGitLab Username
instagramInstagram Username
itchioitch.io Username
kaggleKaggle Username
lastfmLast.fm Username
liberapayLiberapay Username
linkedinLinkedIn Username
mastodonMastodon Username
mediumMedium Username or custom domain(e.g. https://razonyang.com)
patreonPatreon Username
paypalPaypal Username
pinterestPinterest Username
qqQQ Number
quoraQuora Username
redditReddit Username
rssEmpty string for disabling the RSS link
stackoverflowStack Overflow User ID
telegramTelegram Username
tiktokTikTok Username
tipeeeTipeee Username
tumblrTumblr Username
twitterTwitter Username
websiteWebsite URL
weiboWeibo Username
xX username
youtubeYoutube Channel ID
zhihuZhihu Username