How to host a Jekyll blog on Github
The following information and more details can be found on https://jekyllrb.com/docs/
- Go to github.com and create a new repository with your own github username.
- name it as
username.github.io
- Add a readme file.
- Open vscode. Go to your folder where you want to create the site.
git clone REPOSITORY_URL
- Open the folder in vscode
gem install bundler jekyll
jekyll new username.github.io --force
cd username.github.io
- Edit
_config.yml
file. Replace with your details
title: Kaushik Chemburkar
email: attherate@gmail.com
description: >- # this means to ignore newlines until "baseurl:"
Notes for myself
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
twitter_username: _Kaushik
github_username: k4u5hik
mastodon:
- username: kaushikc
instance: mastodon.social
# Build settings
theme: minima
plugins:
- jekyll-feed
- Append the following to the
Gemfile
# install jekyll-admin
gem 'jekyll-admin', group: :jekyll_plugins
- Sass deprecation warnings were disabled by appending the following to the
Gemfile
(Optional)
sass:
quiet_deps: true
- Run the following commands on the terminal
bundle install
bundle exec jekyll serve
- Open
http://localhost:4000/
in your browser - Open
http://localhost:4000/admin/
in your browser - If everything is fine, commit and push the changes to github
git add .
git commit -m "Jekyll clean install"
git push
That’s all! Your site is live at https://username.github.io