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 and the  on GitHub for more information.

Milestones

Demonstrate the highlights of your career by adding Milestones to your Profile. This could be when you got your first job to reaching 100k followers/subscribers.

Example of LinkFree Milestones

Add Milestone

  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 milestones at the root of your json file which will contain one or more social objects. Each social object must have six fields, title, date, icon, color, description and url, which will look like this:
{
    "title": "Started Freelancing",
    "date": "May 2010",
    "icon": "FaDollarSign",
    "color": "grey", // or #808080
    "description": "Started my own business",
    "url": "https://www.eddiejaoude.io/"
}
PropertyRequiredDescription
titletrueMain heading of the milestone
datetrueMonth and Year
icontrueWhat icon would you like displayed with this milestone
colortrueWhat color would you like this milestone to be displayed in. Use hex codes or name of the color
descriptiontrueMore details about the milestone, this can include markdown
urltrueWhere can people learn more about the milestone
isGoalfalseIf this is a future goal

This is what a complete example looks like:

"milestones": [
    {
        "title": "Started Freelancing",
        "date": "May 2010",
        "icon": "FaDollarSign",
        "color": "grey",
        "description": "Started my own business",
        "url": "https://www.eddiejaoude.io/"
    }
]
  1. Now you can commit your file and create a Pull Request, for more details please see Editing Guide