From 4fec76fa631d0dc3848349607ecb749657668254 Mon Sep 17 00:00:00 2001 From: zcraber Date: Wed, 4 Oct 2023 18:40:56 +0530 Subject: [PATCH] updates --- README.md | 18 ++++++++++++++---- _config.yml | 5 ++++- 2 files changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c637ce2..b86c119 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,17 @@

+ + Jekyll version + - Gem (including prereleases) + Gem (including prereleases) - Gem + Gem + + + Gem

@@ -39,14 +45,18 @@ There are multiple ways to install and set up Linkhub. Let's explore each of the 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. Go to the [Linkhub theme repository](https://github.com/digitalmalayali/linkhub-jekyll-theme). +1. Visit [Linkhub theme repository](https://github.com/digitalmalayali/linkhub-jekyll-theme). 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 [Usage guide](https://github.com/digitalmalayali/linkhub-jekyll-theme#usage) for details. +5. Edit the `_config.yml` and `_data` files for customization. Check the [Usage](https://github.com/digitalmalayali/linkhub-jekyll-theme#usage) 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! +### 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`: diff --git a/_config.yml b/_config.yml index 94d9637..6163b7a 100644 --- a/_config.yml +++ b/_config.yml @@ -1,3 +1,6 @@ +# Jekyll +theme: linkhub-jekyll-theme + # Site Configuration name: Linkhub # Name of your website tagline: Links # Set your preferred page title @@ -33,4 +36,4 @@ defaults: layout: "default" # Exclude -exclude: [README.md, Gemfile.lock, .jekyll-cache/, Gemfile] \ No newline at end of file +exclude: [README.md, Gemfile.lock, .jekyll-cache/, .github/, Gemfile, LICENSE.txt, funding.yml, linkhub-jekyll-theme.gemspec] \ No newline at end of file