2021-11-23 12:51:36 +00:00
< p align = "center" > < img src = "logo.png" / > < / p >
2021-11-23 12:54:57 +00:00
2021-11-23 14:13:11 +00:00
# LinkRoots
2021-11-23 12:10:03 +00:00
LinkRoots is a libre, lightweight, self-hosted alternative to Linktree.
## How to use it
2021-11-23 12:35:29 +00:00
2021-11-23 12:10:03 +00:00
1. Clone the repository.
2021-11-23 12:35:29 +00:00
2021-11-23 12:10:03 +00:00
2. Replace `background.png` with any background image of your choice.
2021-11-23 12:35:29 +00:00
2021-11-23 12:10:03 +00:00
3. Edit `roots.json` to modify the page. The example should be enough to help you understand the format, but feel free to ask me questions if you still don't get it!
2021-11-23 12:35:29 +00:00
2021-11-23 12:54:57 +00:00
4. Host it!
2021-11-23 12:10:03 +00:00
## Button types
2021-11-23 12:35:29 +00:00
| Type | Description | Example |
| --- | --- | --- |
2021-11-23 14:28:47 +00:00
| `basic` | A basic button, not associated with any particular site. |  |
| `facebook` | A button for Facebook pages. |  |
| `instagram` | A button for Instagram pages. |  |
| `twitter` | A button for Twitter pages. |  |
| `github` | A button for GitHub pages. |  |
| `youtube` | A button for YouTube pages. |  |
| `linkedin` | A button for LinkedIn pages. |  |
| `pinterest` | A button for Pinterest pages. |  |
| `tumblr` | A button for Tumblr pages. |  |
| `reddit` | A button for Reddit pages. |  |
2021-11-23 14:24:31 +00:00
## Special thanks to:
* The [Neurodiversity Matrix room ](https://matrix.to/#/#neurodiversity:artemislena.eu ), which gave me feedback on UX and the logo.
* [Reactiflux ](https://reactiflux.com ), which helped me every step of the way with technical issues.
* **You**.
