Skip to content
This repository has been archived by the owner before Nov 9, 2022. It is now read-only.

chesterhow/tale

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Tale

Gem Version

Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo here.

Tale screenshot

Features

  • Easy installation
  • Compatible with GitHub Pages
  • Responsive design (looks just as good on mobile)
  • Syntax highlighting, with the help of Pygments
  • Markdown and HTML text formatting
  • Pagination of posts
  • Sticky posts
  • Tags
  • Excerpt management
  • Disqus comments (can be enabled if needed)

Installation

There are 3 ways to install this theme

  1. Install it as a Ruby Gem (for self-hosted sites)
  2. Install it with the jekyll-remote-theme plugin (for GitHub Pages hosted sites)
  3. Fork the project directly

Ruby Gem method

  1. Add this line to your Gemfile:
gem "tale"
  1. Install the theme's gems and dependencies:
$ bundle
  1. In _config.yml add these lines:
theme:      tale

permalink:  /:year-:month-:day/:title
paginate:   5

Remove any other theme: lines.

  1. Rename index.md to index.html. Without this, the jekyll-paginate gem will not work.

  2. In about.md, change the layout: field to post:

layout: post

GitHub Pages method

  1. Add these 2 lines in to your Gemfile:
gem "jekyll-remote-theme"
gem "jekyll-paginate"
  1. Install the newly added gems:
$ bundle
  1. In _config.yml add these lines:
remote_theme: chesterhow/tale

permalink:    /:year-:month-:day/:title
paginate:     5

plugins:
  - jekyll-paginate
  - jekyll-remote-theme

Remove any other theme: or remote_theme: lines.

  1. Rename index.md to index.html. Without this, the jekyll-paginate gem will not work.

  2. In about.md, change the layout: field to post:

layout: post

Fork method

  1. Fork this repository

  2. Delete the unnecessary files/folders: CODE_OF_CONDUCT.md, LICENSE, README.md, tale.gemspec

  3. Delete the baseurl line in _config.yml:

baseurl:  "/tale"   # delete this line

Usage

Once you've installed the theme, you're ready to work on your Jekyll site. To start off, I would recommend updating _config.yml with your site's details.

To build and serve your site, run:

$ bundle exec jekyll serve

And you're all set! Head over to http://127.0.0.1:4000/ to see your site in action.

Enabling Comments

Comments are disabled by default. To enable them, look for the following line in _config.yml and change jekyll-tale to your site's Disqus id.

disqus: jekyll-tale

Next, add comments: true to the YAML front matter of the posts which you would like to enable comments for.

Contributing

Found a bug or have a suggestion? Feel free to create an issue or make a pull request!

License

See LICENSE