update docs

digitalmalayali · Oct 4, 2023 · b09f161 · b09f161
1 parent 7b14494
commit b09f161
Showing 1 changed file with 119 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,27 @@
     </a>
 </p>
 
+## Contents
+- [Contents](#contents)
+- [Features](#features)
+- [Installation](#installation)
+  - [Use GitHub Template (Fastest Way)](#use-github-template-fastest-way)
+  - [Install as GitHub Remote Theme](#install-as-github-remote-theme)
+  - [Install as Ruby Gem](#install-as-ruby-gem)
+- [Configuration](#configuration)
+  - [Adding Site Info](#adding-site-info)
+    - [`_config.yml`](#_configyml)
+  - [Adding Icons](#adding-icons)
+  - [Adding Social Media Links](#adding-social-media-links)
+  - [`social.yml`](#socialyml)
+  - [Adding Instagram/TikTok/YouTube Link-in-bio](#adding-instagramtiktokyoutube-link-in-bio)
+    - [`bio.yml`](#bioyml)
+  - [Adding Links](#adding-links)
+    - [`links.yml`](#linksyml)
+- [Contributing](#contributing)
+- [Development](#development)
+- [License](#license)
+
 ## Features
 - 😊 Based on the original [Linkhub](https://github.com/digitalmalayali/Linkhub) template!
 - 📸 Add links to Instagram, TikTok, YouTube or any posts similar to Later's link-in-bio! 
@@ -38,27 +59,23 @@
 - 🔠 Categorize links; store your links under various categories!
 
 ## Installation
-
 There are multiple ways to install and set up Linkhub. Let's explore each of them.
 
 ### Use GitHub Template (Fastest Way)
-
 If you need the quickest way to set this up or if you're a complete beginner to Jekyll, using the GitHub template is the easiest option. You can also fork the repo.
 
-1. Visit [Linkhub theme repository](https://github.com/digitalmalayali/linkhub-jekyll-theme).
+1. Visit [Linkhub](https://github.com/digitalmalayali/linkhub-jekyll-theme) theme repository.
 2. Click the **Use this template** button.
 3. Select **Create a new repository**.
 4. Give it a name and click **Create repository**.
-5. Edit the `_config.yml` and `_data` files for customization. Check the [Customization](https://github.com/digitalmalayali/linkhub-jekyll-theme#customization) guide for details.
+5. Edit the `_config.yml` and `_data` files for customization. Check the [Customization](#customization) guide for details.
 6. Go to **Settings** > **Pages**. Under **Build and deployment**, select **GitHub Actions** as the source.
-7. If you have a [custom domain](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/), you can enter it. Otherwise, you can view the published website at GitHub.io once the building is complete!
+7. If you have a [custom domain](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/), you can enter it. Otherwise, you can view the published website at `https://<username>.github.io/linkhub-jekyll-theme` once the building is complete!
 
 ### Install as GitHub Remote Theme
-
 Go to your site's `_config.yml` and replace `theme:` with `remote_theme: digitalmalayali/linkhub-jekyll-theme`.
 
 ### Install as Ruby Gem
-
 Add this line to your Jekyll site's `Gemfile`:
 
 ```ruby
@@ -79,30 +96,118 @@ Or install it yourself as:
 
     $ gem install linkhub-jekyll-theme
 
-## Customization
+## Configuration
 Linkhub is super-easy to customize!
 
 ### Adding Site Info
-Edit the `_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.
+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.
+
+#### `_config.yml`
+```yml
+# Jekyll
+theme: linkhub-jekyll-theme
+
+# Site Configuration
+name: Linkhub  # Name of your website
+tagline: Links  # Set your preferred page title
+description: A free, open-source Jekyll link-in-bio theme.  # Also used as a meta description
+favicon: https://picsum.photos/100 # Path / URL to the favicon of your website (e.g., 'assets/images/favicon.png')
+logo: https://picsum.photos/200 # Path / URL to the logo (e.g., 'assets/images/logo.png')
+url: https://link.example.com # URL of your website
+ga4: G-XXXXXXX # Google Analytics 4 measurement ID (optional). Remove it if not needed.
+twitter:
+  username: username # Used for SEO
+  card: summary
+image:
+  path: https://picsum.photos/200 #Used for SEO
+  height: 100
+  width: 100
+  alt: logo
+
+# Verified Badge Configuration
+badge: true  # Set to 'true' or 'false' to enable / disable the badge
+icon: ri:verified-badge-fill  # Enter the icon name for the badge from Iconify Design (https://icon-sets.iconify.design/)
+color: '#dfb221'  # Define the color of the badge
+
+# Plugins
+plugins:
+  - jekyll-seo-tag
+ 
+# Defaults
+defaults:
+  -
+    scope:
+      path: ""
+    values:
+      layout: "default"    
+
+# Exclude
+exclude: [README.md, Gemfile.lock, .jekyll-cache/, .github/, Gemfile, LICENSE.txt, funding.yml, linkhub-jekyll-theme.gemspec]
+```
 
 ### Adding Icons
 Icons are powered by the free and open-source icon framework [Iconify](https://github.com/iconify), offering a selection of over 150,000 icons. Visit the [Iconify icon sets website](https://icon-sets.iconify.design/) to search for your preferred icon. Once you find your desired icon, copy its name and use it in the respective fields.
 
 ### Adding Social Media Links
-Edit the `social.yml` file in the `_data` folder to add your social media profiles, along with your preferred icons and colors.
+Edit the [social.yml](`social.yml`) file in the [_data](`_data`) folder to add your social media profiles, along with your preferred icons and colors.
+
+### `social.yml`
+```yml
+- name: facebook
+  url: https://www.facebook.com/example
+  icon: ri:facebook-fill
+  color: '#1877F2'
+
+- name: instagram
+  url: https://www.instagram.com/example
+  icon: ri:instagram-fill
+  color: '#E4405F'
+```
 
 ### Adding Instagram/TikTok/YouTube Link-in-bio
-Like Later's link-in-bio feature, you can include external links to your Instagram, TikTok, and other posts by adding the name of social media, the link and image URL/path to `bio.yml` in the `_data` folder. You can either upload thumbnails of your Instagram, TikTok and YouTube posts to an image hosting service or create an `images` folder in `assets` and place them there. The image size doesn't matter, and it will be displayed similarly to a 3-column Instagram grid.
+Like Later's link-in-bio feature, you can include external links to your Instagram, TikTok, and other posts by adding the name of social media, the link and image URL/path to [bio.yml](`bio.yml`) in the [_data](`_data`) folder. You can either upload thumbnails of your Instagram, TikTok and YouTube posts to an image hosting service or create an `images` folder in `assets` and place them there. The image size doesn't matter, and it will be displayed similarly to a 3-column Instagram grid.
+
+#### `bio.yml`
+```yml
+- name: Instagram
+  items:
+    - url: https://www.example.com
+      image: https://picsum.photos/700/400 # You can use paths to images in the assets folder, e.g., assets/images/insta.jpg.
+
+- name: YouTube
+  items:
+    - url: https://www.example.com
+      image: https://picsum.photos/300/400
+```
 
 ### Adding Links
-Edit the `links.yml` file in the `_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](`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.
+
+#### `links.yml`
+
+```yml
+- category: Blogs
+  items:
+    - title: Example
+      url: https://www.example.com
+      icon: ri:film-fill
+      tag: New
+
+    - title: Example 2
+      url: https://www.example.org
+      icon: simple-icons:googlenews
+
+- category: Products
+  items:
+    - title: Example 3
+      url: https://www.example.com
+      icon: ri:ball-pen-fill
+```
 
 ## Contributing
-
 Bug reports and pull requests are welcome on [GitHub](https://github.com/digitalmalayali/linkhub-jekyll-theme). If you like this theme, please give it a star!
 
 ## Development
-
 To set up your environment to develop this theme, run `bundle install`.
 
 Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
@@ -112,5 +217,4 @@ When your theme is released, only the files in `_layouts`, `_includes`, `_data`
 To add a custom directory to your theme-gem, please edit the regexp in `linkhub-jekyll-theme.gemspec` accordingly.
 
 ## License
-
 The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).