Documentation

Here you should find everything you need from getting started with creating your Profile to more advanced topics. We welcome contributions, check out the LinkFree Repo  and the documentation source on GitHub for more information.

Social shortcuts

Add a shortcut to your favourite social media accounts at the top of your Profile.

Example of LinkFree Social Shortcut icons

Add Social shortcuts

  1. Find your json file in the data folder using your GitHub username, for example data/sarajaoude.json

If you need help on how to edit this file, please see the Editing Guide

  1. Add a collection called socials at the root of your json file which will contain one or more social objects. Each social object must have two fields, platform and url, which will look like this:
{
  "icon": "FaTwitter",
  "url": "https://twitter.com/eddiejaoude"
}

This is what a complete example looks like:

"socials": [
  { "icon": "FaTwitter", "url": "https://twitter.com/eddiejaoude" },
  { "icon": "FaGithub", "url": "https://github.com/eddiejaoude" },
  { "icon": "FaYoutube", "url": "https://youtube.com/eddiejaoude" }
]
  1. Now you can commit your file and create a Pull Request, for more details please see Editing Guide

The icon you would like displayed. We support the following icon sets: Fa and Si from React Icons.

Clicks on these social shortcuts that match any of your links will also increment their respective counters