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'
params.yaml
1topAppBar:
2 social:
3 github: foobar
params.json
1{
2 "topAppBar": {
3 "social": {
4 "github": "foobar"
5 }
6 }
7}
Author Widget
Set up social links by editing a file config/_default/author.toml
with the following content:
1[social]
2 email = "user@domain.tld"
3 github = "githubusername"
Footer
Set up social links by putting the following content in config/_default/params.toml
.
1[social]
2email = "user@domain.tld"
3github = "githubusername"
Platforms
The value can be changed to a full URL if necessary.
Platform | User Identifier |
---|---|
email | Email Address |
facebook | Facebook Username |
facebookgroup | Facebook Group Name |
github | GitHub Username |
gitlab | GitLab Username |
instagram | Instagram Username |
itchio | itch.io Username |
linkedin | LinkedIn Username |
quora | Quora Username |
stackoverflow | Stack Overflow User ID |
tumblr | Tumblr Username |
twitter | Twitter Username |
weibo | Weibo Username |
zhihu | Zhihu Username |
reddit | Reddit Username |
telegram | Telegram Username |
qq | QQ Number |
dockerhub | Docker Hub Username |
bitbucket | Bitbucket Workspace ID |
kaggle | Kaggle Username |
medium | Medium Username or custom domain(e.g. https://razonyang.com) |
lastfm | Last.fm Username |
bibibili | BiliBili User ID |
youtube | Youtube Channel ID |
discord | Discord Invite Code |
discourse | Forum URL |
tiktok | TikTok Username |
pinterest | Pinterest Username |
mastodon | Mastodon Username |
liberapay | Liberapay Username |
paypal | Paypal Username |
patreon | Patreon Username |
tipeee | Tipeee Username |
rss | Empty string for disabling the RSS link |
website | Website URL |
Comments