mirrors/tale
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
Minimal Jekyll theme for storytellers
47 commits 1 branch 0 tags 1.9 MiB
SCSS 65.7%
HTML 21%
JavaScript 10.7%
Ruby 2.6%
Go to file
Chester How 2655988bd6 Update gem version and add gem badge
2018-01-21 21:29:54 +08:00
_includes Convert theme to gem 2018-01-08 20:23:56 +08:00
_layouts Add home layout 2018-01-08 22:36:00 +08:00
_posts Remove extra text in post 2017-12-17 16:36:35 +08:00
_sass Styling fix for IE 2018-01-17 21:17:37 +08:00
assets Convert theme to gem 2018-01-08 20:23:56 +08:00
.gitignore Add home layout 2018-01-08 22:36:00 +08:00
_config.yml Remove unnecessary theme field from _config.yml 2018-01-09 00:55:26 +08:00
about.md Write About page and Introducting Tale post 2017-03-29 12:04:00 +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 Convert theme to gem 2018-01-08 20:23:56 +08: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 Update gem version and add gem badge 2018-01-21 21:29:54 +08:00
tale.gemspec Update gem version and add gem badge 2018-01-21 21:29: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

Installation

As a Jekyll theme

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

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

  2. Add these 2 lines in to _config.yml:

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

As a Fork

  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.

Contributing

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

License

See LICENSE