jekyll-socials

A plugin to help add social media info to your site. For more information, check the documentation.

This plugin supports three web font libraries for rendering social media icons:

1. FontAwesome - A comprehensive icon library with support for brands and general symbols
2. Academicons - Specialized icons for academic platforms and publications
3. Scholar Icons - Additional icons for technical and coding platforms

While this plugin comes with built-in support for the three font libraries above, you can use icons from any other font library you add to your site. Simply provide the icon class name in the logo field of a custom social or when overriding a built-in social's icon. The plugin will automatically detect whether the value is a file path (by checking for file extensions like .png, .jpg, .svg) or an icon class.

The plugin includes built-in support for 53 social media and academic platforms:

academia_edu, acm_id, arxiv_id, dblp_url, hal_id, ieee_id, inspirehep_id, lattes_id, orcid_id, osf_id, publons_id, research_gate_profile, scholar_userid, scopus_id, semanticscholar_id

blogger_url, bluesky_url, discord_id, facebook_id, flickr_id, instagram_id, mastodon_username, medium_username, pinterest_id, quora_username, reddit_username, spotify_id, telegram_username, tiktok_username, tumblr_username, twitch_username, x_username, youtube_id

github_username, gitlab_username, keybase_username, kaggle_id, lastfm_id, letterboxd_id, linkedin_username, stackoverflow_id, strava_userid, unsplash_id, wikidata_id, wikipedia_id, zotero_username

cv_pdf, email, rss_icon, wechat_username, whatsapp_number, work_url

Additionally, the plugin supports custom socials with user-provided logos (images or icon classes) and URLs.

You can override the default icons for any of the built-in social platforms. This is useful if you want to use a different icon from a different font library. For example, to use a different Letterboxd icon:

letterboxd_id:
  value: your_letterboxd_username # the actual username or ID value
  logo: fa-brands fa-letterboxd # override with custom icon class

This allows you to customize the appearance of any built-in social while keeping all the URL handling logic intact.

For socials not in the built-in list, you can create custom entries with your own logos and URLs:

custom_social:
  logo: custom-font-icon-class # Any icon class from fonts you've added
  title: My Custom Social
  url: https://example.com

To build and release a new gem version:

1. Build the gem - This creates a .gem file from the current gemspec:

   gem build jekyll-socials.gemspec

2. Push to RubyGems - This publishes the gem to RubyGems.org, making it available for installation:

   gem push jekyll-socials-X.X.X.gem

   Replace X.X.X with the actual version number (e.g., jekyll-socials-0.0.6.gem).

The version number should be updated in lib/jekyll-socials/version.rb before building.