Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zcraber committed Oct 5, 2023
1 parent 90de18f commit 616c238
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@
- [`_config.yml`](#_configyml)
- [Adding Icons](#adding-icons)
- [Adding Social Media Links](#adding-social-media-links)
- [`social.yml`](#socialyml)
- [`social.yml`](#socialyml)
- [Adding Instagram/TikTok/YouTube Link-in-bio](#adding-instagramtiktokyoutube-link-in-bio)
- [`bio.yml`](#bioyml)
- [Remove Instagram/TikTok/YouTube Link-in-bio](#remove-instagramtiktokyoutube-link-in-bio)
- [Adding Links](#adding-links)
- [`links.yml`](#linksyml)
- [Contributing](#contributing)
Expand Down Expand Up @@ -97,7 +98,7 @@ Or install it yourself as:
$ gem install linkhub-jekyll-theme
## Configuration
Linkhub is super-easy to customize!
Linkhub is super-easy to customize! There is only one `layout` and that is [default.html](_layouts/default.html). Also, there are no `_posts`.

### Adding Site Info
Edit the [_config.yml](_config.yml) file to specify your website's name, page title, description, Google Analytics and whether to show/hide the verified badge. This information will also be used for meta tags.
Expand Down Expand Up @@ -151,7 +152,7 @@ Icons are powered by the free and open-source icon framework [Iconify](https://g
### Adding Social Media Links
Edit the [social.yml](_data/social.yml) file in the [_data](_data) folder to add your social media profiles, along with your preferred icons and colors.

### `social.yml`
#### `social.yml`
```yml
- name: facebook
url: https://www.facebook.com/example
Expand Down Expand Up @@ -180,8 +181,15 @@ Like Later's link-in-bio feature, you can include external links to your Instagr
image: https://picsum.photos/300/400
```

### Remove Instagram/TikTok/YouTube Link-in-bio
If you'd like to remove Instagram/TikTok/YouTube link-in-bio altogether, remove or comment out the following line in [default.html](_layouts/default.html) layout.

```liquid
{% include bio.html %}
```

### Adding Links
Edit the [links.yml](_data/links.yml) file in the [_data](_data) folder to add link categories, links, icons, and tags. Refer to the provided examples and the [demo](https://digitalmalayali.github.io/linkhub-jekyll-theme/) for a better understanding.
Edit the [links.yml](_data/links.yml) file in the [_data](_data) folder to add link categories, links, icons, and tags. Refer to the provided examples and the [demo](https://digitalmalayali.github.io/linkhub-jekyll-theme/) for a better understanding. `tag` variable is optional.

#### `links.yml`

Expand Down

0 comments on commit 616c238

Please sign in to comment.