Skip to content
This repository has been archived by the owner on Aug 11, 2021. It is now read-only.

minimal blog theme for jekyll (no longer maintained, see blog-hugo-theme)

License

Notifications You must be signed in to change notification settings

muthukrishnandev/blog-theme-jekyll

Repository files navigation

blog-theme

blog-theme is a clean and minimalist theme for Jekyll, focuses on pure and efficient writing. This is a fork from Moving.

Installation

If you want to create a new blog using blog-theme. You can follow these steps after setting up the Jekyll environments:

Clone this repository:

git clone https://github.com/muthukrishnandev/blog-theme.git

Move into that directory:

cd blog-theme/

Install required gems using bundle:

bundle install

Run the blog in localhost

jekyll serve

Once you successfully run the blog-theme blog, you can modify the theme and add posts by yourself, have fun!

Usage

You can modify the _config.yml to custom your blog. An example is if you want to change blog title, you can change the title.

title: Blog Theme # The title of the blog
short_title: # short title of the blog, if empty, title is used
description: > # this means to ignore newlines until "url:"
  Simple Blog description

# Site url Details
url: https://muthukrishnandev.github.io # this is your site's root address. (No trailing slash at the end)
baseurl: "/blog-theme" # this is your site's path after domain address. (No trailing slash at the end)

author:
  name: Blog Author # Your name
  email: [email protected] # your email shown in the footer
  about: a short description about you. # short description about you in about page
  image_url: "https://via.placeholder.com/500x500.png?text=Author%20Photo" # avatar in about page

# refer to https://shopify.github.io/liquid/filters/date/ if you want to customize this
date_format: "%b %d" # date format of posts in home page

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.

License

The theme is available as open source under the terms of the MIT License.