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.
Quickstart
Add your profile
There are 4 ways you can add your profile, but for this Quickstart we will use the GitHub UI.
To do this, you need a GitHub account. If you do not have one yet, you can create one for free with an email address and password.
- Log in to your GitHub Account
- Visit the LinkFree repo
- If you wish to be kept up to date with the repo, hit that "Star" at the top right
- Click on Fork
- Accept the default fork creating a copy of the LinkFree project in your account - this will take you to the forked repo
- Click add file and select "create new file"
- In the file path at the top, add
data/
followed by your GitHub username, exactly as it appears including capitalisation, and then append.json
to it.
For example for username "SaraJaoude":
- Correct:
LinkFree/data/SaraJaoude.json
(including capitalisation in filename)- Incorrect:
LinkFree/data/sarajaoude.json
(filename capitalisation does not match username capitalisation)
- For the file contents use the json structure below:
{
"name": "Sara Jaoude",
"bio": "Lawyer turned **Digital Nomad**. Travel enthusiast Yoga & Peloton aficionado"
}
field | type | description |
---|---|---|
name | string | Your display name on your Profile |
bio | string | Your description about yourself (you can use markdown here) |
- Now add links to your social media and other content (for example: website) so they appear on your Profile.
{
"name": "Sara Jaoude",
"bio": "Lawyer turned **Digital Nomad**. Travel enthusiast Yoga & Peloton aficionado",
"links": [
{
"name": "Follow me on Twitter",
"url": "https://twitter.com/SaraJaoude",
"icon": "FaTwitter"
}
]
}
note: do not have duplicate links (url)
field | type | description |
---|---|---|
name | string | The display name for the button |
url | string | Full url to the resource |
icon | string | The icon you would like displayed. We support the following icon sets: Fa and Si from React Icons. You can search available icons |
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://www.instagram.com/eddieandsaraexplore/",
"icon": "FaInstagram"
}
]
- Scroll to the bottom and commit new file by adding the commit message that starts
data:
followed by your GitHub username (for exampledata: SaraJaoude
)
You can skip optional extended message
NOTE: Please use the online JSON Lint tool to check if your JSON file is error free before committing your pull request.
- Click
create new branch
and you can use the default name provided - Then, click
Propose new file
- HIGHLY IMPORTANT: Click
compare across forks
and you will see 4 drop downs
Dropdown | Description | Example values |
---|---|---|
1st dropdown | Base repository (destination) | EddieHubCommunity/LinkFree |
2nd dropdown | Base repository branch (destination) | main |
3rd dropdown | Your repository (source) | your-username/LinkFree |
4th dropdown | Your repository branch (source) | your-username-patch-1 |
The first dropdown for the base
repository (destination) should be set to EddieHubCommunity/LinkFree
not your username your-username/LinkFree
.
- Click
Create pull request
- The description will be filled with a template, please fill in the appropriate sections
-
Click
Create pull request
-
Now you need to wait to have your Pull Request (changes) reviewed
An approving review from one of LinkFree's maintainers will show a green check mark next to their id.
- You will receive a GitHub notification when you have a comment, review, or your Pull Request has been merged
- Once merged, your profile will be available a few minutes later on your custom URL (linkfree.io/SaraJaoude)
Example Profiles
Looking for inspiration? You can view the following profiles for an example:
Next steps
- How to edit and add more to your profile
- Add social shortcuts to your profile
- Add tags to your profile
- Add events to your profile
- Add testimonials to your profile