mirrors/tale
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Minimal Jekyll theme for storytellers
129 commits 1 branch 0 tags 1.9 MiB
SCSS 65.7%
HTML 21%
JavaScript 10.7%
Ruby 2.6%
Find a file
Michal Jirku 53004a990c Pimp the details/summary elements
2021-04-19 21:21:50 +02:00
_includes Drop the '2' suffix for stlv 2020-12-26 19:17:37 +01:00
_layouts Add perex support 2021-04-19 17:03:06 +02:00
_pages Add tag cloud to post, fix appearance 2021-02-20 21:45:31 +01:00
_posts Add missing favicons and a post w/ sidenotes. 2020-11-23 21:49:02 +01:00
_sass Pimp the details/summary elements 2021-04-19 21:21:50 +02:00
assets Make sidenotes more resilient to dynamic changes 2020-12-26 22:09:46 +01:00
.gitignore Customize tale theme (& add sidenotes+footnotes). 2020-11-23 21:40:33 +01:00
_config.yml Fix disqus implementation and update gemspec 2019-10-24 14:56:51 +08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-06-21 22:52:34 +08:00
favicon.ico Add favicon 2017-12-19 23:04:21 +08:00
Gemfile Move Dependency to tale.gemspec File 2018-10-06 18:53:56 +02:00
index.html Minor fixes 2018-01-08 23:09:20 +08:00
LICENSE Convert theme to gem 2018-01-08 20:23:56 +08:00
README.md Fix disqus implementation and update gemspec 2019-10-24 14:56:51 +08:00
tale.gemspec update gemspec 2020-09-16 13:48:54 +08:00

README.md

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
  • 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