https://github.com/cecilapp/links
Links is a Linktree alternative powered by Cecil, Tailwind CSS and Font Awesome.
https://github.com/cecilapp/links
cecil cecil-starter static-site tailwindcss
Last synced: about 1 year ago
JSON representation
Links is a Linktree alternative powered by Cecil, Tailwind CSS and Font Awesome.
- Host: GitHub
- URL: https://github.com/cecilapp/links
- Owner: Cecilapp
- License: mit
- Created: 2022-05-01T22:36:29.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-26T22:52:18.000Z (over 2 years ago)
- Last Synced: 2024-04-13T21:55:13.247Z (about 2 years ago)
- Topics: cecil, cecil-starter, static-site, tailwindcss
- Language: CSS
- Homepage: https://links.cecil.app
- Size: 3.43 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
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 --ask
```
## 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 identities in [`cecil.yml`](cecil.yml):
```yaml
title:
baseurl:
baseline: "" # optional, recommended
description: "" # optional, recommended
author: # used by metatags, optional
name:
url:
email: # used in social identities block, optional
social: # social identities
: # github, linkedin, instagram, youtube, mastodon, bluesky, threads, twitter or x
url:
avatar: avatar.png
image: avatar.png # Open Graph image, optional, recommended
manifest:
theme_color: "#0369a1" # theme color
background_color: "#fff" # PWA background color
serviceworker:
enabled: false # turns on PWA
# CSS theme and buttons colors
links:
theme: default # "default, "gradient-1" or "gradient-2"
buttons:
color: page # page or css ('page' by default)
```
> [!TIP]
> The exhaustive [Cecil](https://cecil/app) documentation is available at [cecil.app](https://cecil.app/documentation/configuration/).
### Manage page
From `pages/index.md` file you can:
1. change page structure with _blocks_ array in _front matter_
2. add links in _front matter_
3. add rich content authoring in Markdown in page _body_ (optional)
```yaml
---
blocks:
- name: content # page content
- name: links # page links
- name: social # social identities
links:
- title:
url:
color: "<#hexa_code>" # 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
You can disable buttons custom color:
_cecil.yml:_
```yaml
links:
buttons:
color: css
```
### Theme
[Tailwind CSS](https://tailwindcss.com) is required:
```bash
npm install -D tailwindcss
```
#### Theme colors
You can change [theme colors](ttps://tailwindcss.com/docs/customizing-colors) through the file `tailwind.config.js`, then rebuild CSS:
```bash
npx tailwindcss -i ./themes/links/tailwind.css -o ./assets/styles.css
```
#### Theme CSS
You can change theme CSS through the file `tailwind.css`:
1. Copy `./theme/links/tailwind.css` to `./tailwind.css`
2. Rebuild CSS:
```bash
npx tailwindcss -i ./tailwind.css -o ./assets/styles.css
```
## Update
If you want to update the [_links_](https://github.com/Cecilapp/theme-links#readme) theme and _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)