Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arnaudligny/ligny.fr
My Linktree clone powered by Cecil.
https://github.com/arnaudligny/ligny.fr
Last synced: 2 days ago
JSON representation
My Linktree clone powered by Cecil.
- Host: GitHub
- URL: https://github.com/arnaudligny/ligny.fr
- Owner: ArnaudLigny
- License: mit
- Created: 2015-06-11T17:09:44.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-16T13:37:27.000Z (6 months ago)
- Last Synced: 2024-05-16T14:47:44.319Z (6 months ago)
- Language: CSS
- Homepage: https://ligny.fr
- Size: 2.51 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
_Links_ is a Linktree alternative powered by [Cecil](https://cecil.app), [Tailwind CSS](https://tailwindcss.com) and [Font Awesome](https://fontawesome.com).
[](https://links.cecil.app)
Demo:
## Install
> [!IMPORTANT]
> PHP 8.1 and [Composer](https://getcomposer.org) are required.
The easiest way to create a new Links project is using Composer:
```bash
composer create-project cecil/links my-project
```
## Usage
### Preview
You can easily preview your site locally with the following command:
```bash
php cecil.phar serve --open
```
> [!TIP]
> The option `--open` automatically open your site in the default web browser.
### Configuration
Define site configuration and social links in [`cecil.yml`](cecil.yml):
```yaml
title:
baseurl:
baseline: "" # optional, recommended
description: "" # optional, recommended
author: # used by metatags, optional
name:
url:
social: # social links
: # twitter, github, linkedin, instagram, youtube
url:
avatar: avatar.png
metatags:
favicon:
image: avatar.png # optional, recommended
image: avatar.png # Open Graph image, optional, recommended
source: https://github.com/Cecilapp/Links # GitHub repository
```
> [!TIP]
> The exhaustive [Cecil](https://cecil/app) documentation is available at [cecil.app](https://cecil.app/documentation/configuration/).
### Manage links
Edit file `pages/index.md` to:
1. add links in _front matter_
2. free content in _body_ (optional)
```yaml
---
links:
- title:
url:
color: "" # hexadecimal color code, optional (e.g. "#1DA1F2")
icon: :<name> # Font Awesome icon (https://fontawesome.com/icons), optional (e.g. "brands:github")
---
Content here.
```
## Publish
Run the following command:
```bash
php cecil.phar build
```
Then just deploy the content of __site_ directory to your web hosting solution.
## Customize color
### Theme
You can change the [theme color](ttps://tailwindcss.com/docs/customizing-colors) through the file `tailwind.config.js`, then rebuild CSS:
```bash
npm install
npx tailwindcss -i ./assets/tailwind.css -o ./assets/styles.css
```
### Social links
Out of the box, only the color of the following social providers are supported:
Twitter, GitHub, LinkedIn, Instagram and YouTube.
## Update
If you want to update _component themes_ (i.e.: _[fontawesome](https://github.com/Cecilapp/theme-fontawesome#readme)_, _[pwa](https://github.com/Cecilapp/theme-pwa#readme)_ and _[netlity](https://github.com/Cecilapp/theme-netlify#readme)_) you must run the following command:
```bash
composer update
```
## License
_Links_ is a free software distributed under the terms of the MIT license.
© [Arnaud Ligny](https://arnaudligny.fr)