29 lines
No EOL
1.4 KiB
Markdown
29 lines
No EOL
1.4 KiB
Markdown
# LinkRoots
|
|
<p align="center"><img src="logo.png"/></p>
|
|
LinkRoots is a libre, lightweight, self-hosted alternative to Linktree.
|
|
|
|
## How to use it
|
|
|
|
1. Clone the repository.
|
|
|
|
2. Replace `background.png` with any background image of your choice.
|
|
|
|
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!
|
|
|
|
4. Host it!
|
|
|
|
|
|
## Button types
|
|
|
|
| Type | Description | Example |
|
|
| --- | --- | --- |
|
|
| `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. |  | |