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.
Links
Let people discover all your great content in one place by adding links to your social media account and other resources.
- Find your
json
file in thedata
folder using your GitHub username, for exampledata/sarajaoude.json
If you need help on how to edit this file, please see the Editing Guide
- Add a collection called
links
at the root of yourjson
file which will contain one or more objects that must have three fieldsname
,url
andicon
.
This is an example of a single link object:
{
"name": "Follow me on Twitter",
"url": "https://twitter.com/SaraJaoude",
"icon": "FaTwitter"
}
field | type | required | description |
---|---|---|---|
name | string | true | The display name for the button |
url | string | true | Full url to the resource |
icon | string | true | The icon you would like displayed. We support the following icon sets: Fa and Si from React Icons. |
group | string | false | Optional property to group links together, any without a group will be added to the end in a new group called "Others". If no groups are used then no groups are displayed including "Others". |
To add more links add another object inside the links collection. For example:
"links": [
{
"name": "Follow me on Twitter",
"url": "https://twitter.com/SaraJaoude",
"icon": "FaTwitter"
},
{
"name": "Follow me on Instagram",
"url": "https://twitter.com/EddieAndSaraExplore",
"icon": "FaInstagram"
}
]
- Now you can commit your file and create a Pull Request, for more details please see Editing Guide
Clicks on these social shortcuts that match any of your links will also increment their respective counters