How to customize jeykyll template

Understanding the flow of the codebase

By Bibek Lakra

This template is originally developed by Dean Attali. Many open source contributors have contributed ans actively participated in this project. Main key feature of this website include, very beautiful and quick hostable website, rooms for customization and very new concepts of website development. I came to know about this template from Invictus which is developed by Abhay Mishra.

Here is a wuick quide to setup this peoject on local machine.

Prerequisites:

1. Ruby:

Jekyll is built with Ruby, so ensure you have Ruby installed. Check it with:

ruby -v

If not installed, follow the installation instructions here.

2. Bundler: This helps manage dependencies. Install it using:

gem install bundler

3. Jekyll: Install Jekyll globally:

gem install jekyll

Running the Jekyll Website:

1. Navigate to your project directory:

cd /<path-to-your-jekyll-site>

2. Install dependencies (if your site has a Gemfile):

bundle install

3. Serve the site:

bundle exec jekyll serve

Alternatively, if you don’t use Bundler:

jekyll serve

4. Access the site:

Open your browser and go to: http://localhost:4000. You can also checkout the server address in the terminal


Common Issues:

  • Port already in use: Use a different port:
     jekyll serve --port 8080
    
  • Watch mode not working: Add --livereload to automatically refresh the browser on changes:
     jekyll serve --livereload
    

Notification

Note: Checkout this guide for more detailed installation.

Share: X (Twitter) Facebook LinkedIn