Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greatwizard/gistlinktree
Generate a link tree from a configuration file.
https://github.com/greatwizard/gistlinktree
generator gist gistlinktree link linktree tree website
Last synced: 15 days ago
JSON representation
Generate a link tree from a configuration file.
- Host: GitHub
- URL: https://github.com/greatwizard/gistlinktree
- Owner: GreatWizard
- License: agpl-3.0
- Created: 2021-12-08T21:35:30.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-02-02T13:11:37.000Z (almost 3 years ago)
- Last Synced: 2024-10-09T12:50:41.659Z (3 months ago)
- Topics: generator, gist, gistlinktree, link, linktree, tree, website
- Language: JavaScript
- Homepage:
- Size: 62.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gist🔗🌲
[](https://www.gnu.org/licenses/agpl-3.0)
[](https://github.com/GreatWizard/gistlinktree/actions/workflows/test.yml)
Generate a link tree from a configuration file.
## Installation
```shell
npm install --save gistlinktree
```
## Usage
```shell
npx gistlinktree [options]
```
### Options
```shell
-c, --config string Path to the config file
-o, --output-dir string Output directory
-h, --help Print this usage guide
```
Config file is defaulted to `gistlinktree.yml`.
Output directory is defaulted to `dist`.
## Configuration
Define a `gistlinktree.yml` file as following:
```yaml
title: My Personal Link Tree # Main title of your page
avatar: static/avatar.jpg # avatar used in priority over gravatar
gravatar: # load avatar from gravatar
theme: dracula # theme of the stylesheet; values: default (by default), dracula
index:
copy: # copy file at the root directory without changing the name
- input: static/icons/favicon.ico
- input: static/CNAME
links:
- outputDir: my-tiny-static-website # build the gist into a subfolder
gistID: # you need to specify the if of your gist
copy:
- input: static/icons/website.ico # file to copy
output: favicon.ico # rename the file
- title: Github.com # title of the button link
url: https://github.com # define the URL of the link
linksSocialPosition: bottom # position of the social links in the page; values: bottom (by default), top
linksSocial:
- type: github # icon of the social link (use Font Awesome solid and brand icon names)
url: https://github.com/ # define the URL of the social link
```
ℹ️ SASS/SCSS/CSS files added in the `index.copy` list are added automatically into the generated `index.html`.
### Format conversion
During the copy process or the build process of a gist, it converts:
- markdown files into HTML
- SASS/SCSS files into CSS
### Social Links
Only solid and brand icons coming from Font Awesome v5.15 are available: https://fontawesome.com/v5.15/icons?d=gallery&p=2&s=brands,solid&m=free