Skip to content

An open-source and self-hosted, privacy focused alternative to linktree, easily configurableand easy to deploy.

Notifications You must be signed in to change notification settings

willianrod/linkme-tree

Repository files navigation


An open-source and self-hosted, privacy focused alternative to linktree, easily configurableand easy to deploy.


Description

If you're looking for a personal website, links to your social media, links to personal projects, and a place to put all your links, this is for you, all of this with no cookies and no trackers. Just what matters!!

Configuration

There are two ways you can customize LinkMe Tree for your needs. One of them is to update the YAML file inside src/data, and the second one is to have Gist file with all your information to be deployed.

Updating src/data/index.yml

If you want to have everything in one place, this option is for you. You just need to fork this repository, update the file with all your information and deploy it anywhere you want.

Using a gist file

If you want to have all information easily reachable and not have to do lots of commits to update your links, this option is for you. Have in mind that for your update to take effect, you'll have to manually trigger re-deploy on Vercel.

First, you will need to create a new gist file here and give it the name you want with .yml extension. Then, copy the src/data/index.yml contents to your gist and start customizing it with your information. Once you're done, you will need to get the raw gist file URL like this one https://gist.githubusercontent.com/willianrod/f9af9032d4c5d0087d92dea26a755af8/raw/linkme-tree.yml.

With the gist URL, you just need to add an environment variable named GIST_URL with your gist URL and you're ready to deploy 🎉.

Deploy your own

Now that you're ready, you can go ahead and deploy on your own Vercel account.

Deploy with Vercel

About

An open-source and self-hosted, privacy focused alternative to linktree, easily configurableand easy to deploy.

Topics

Resources

Stars

Watchers

Forks