https://github.com/brijeshb42/jekyll-read

Yet another jekyll theme.
https://github.com/brijeshb42/jekyll-read

Last synced: about 2 months ago
JSON representation

Yet another jekyll theme.

• Host: GitHub
• URL: https://github.com/brijeshb42/jekyll-read
• Owner: brijeshb42
• Created: 2015-12-06T16:46:23.000Z (about 9 years ago)
• Default Branch: gh-pages
• Last Pushed: 2015-12-09T11:46:50.000Z (about 9 years ago)
• Last Synced: 2023-05-11T12:05:15.271Z (over 1 year ago)
• Language: CSS
• Homepage: http://bitwiser.in/Jekyll-Read
• Size: 23.4 KB
• Stars: 4
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Jekyll-Read Theme

A jekyll theme built on top of default jekyll theme and inspired by [Read WordPress theme](http://themes.pixelwars.org/read-wp/).

## Features:

* Responsive Layout

* Sitemap

* Atom feed

* Mailchimp Newsletter subscription

* Disqus Commenting

* Google Analytics

* Scheme.org Formatting

* Featured image for posts

* Minimal configuration

## Installing

* Download `zip` from the latest [release](https://github.com/brijeshb42/Jekyll-Read/releases).

* Change values in `_config.yml` as required. This file is commented wherever required.

* Create a file named `CNAME` and your domain (example.com) as its only line if you have your own domain.

* Change the value of the `url` variable to your blog's URL (eg: `http://githubusername.github.io`).

* Uncomment and add a value to `disqus` variable if you want to have disqus commenting enabled.

* Uncomment and add values to `ga_id` and `ga_domain` to add Google Analytics.

* Add a Mailchimp Newsletter form submission URL to `mailchimp` to add a newsletter subscription form.

* There's a file `projects.yml` in `_data` directory by default. You can add `title` and `url` values to it to add a **Project** submenu in the top navigation. Delete this file to remove the submenu.

* Replace `favicon.ico`, `favicon.png` and `sharer.png` with your own images.

* Create new posts in the `_posts` directory. If a `cover` variable is present in the front matter as shown in the `2015-12-06-an-example-post` file, it will be used as a cover image for that post. Its value should be absolute URL to the image.

* Now install `jekyll` and `jekyll-paginate` gems to test the site locally.

* Run `jekyll serve -w` in the theme's directory to run the server and goto [http://127.0.0.1:4000](http://127.0.0.1:4000) to check the changes.

* If everything works well, push your changes to github.