Giter VIP home page Giter VIP logo

tale's Introduction

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

tale's People

Contributors

abdalimran avatar cantino avatar chesterhow avatar danaugrs avatar deborah-digges avatar denismcdonald avatar drewolson avatar fwenzel avatar grantbachman avatar ks3 avatar madeindjs avatar pigne avatar prodingerd avatar robbinespu avatar schdck avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

tale's Issues

Make Disqus and Google Analytics optional

Hi @chesterhow,

First off, great theme; I've decided to use it for my blog.

One little suggestion I would make is to make Disqus and Google Analytics optional. I am not familiar enough with Jekyll to know if you can provide optional build params.

If not I would probably remove these two from the base repo, especially Google Analytics.

Github Method doesn't seem to work for my forked theme

First of all, thank you for the great theme. I am having problems understanding the instructions in the GitHub Pages method, and I am not even sure if it is applicable to me:

I am using Github Pages I can't get Jekyll to render a page behind a link. I am using the following fork of Tale: https://github.com/antonostrovsky/tale

If I clone the template into a local repo and run bundle exec jekyll serve I get a page with a Contact link that I can successfully follow. The generated _site folder contains a subfolder 'contact' with index.html within it.

I then create an empty repository (https://github.com/antonostrovsky/test_site) at Github and specify this template in _config.yml:

remote_theme: antonostrovsky/tale

The template is successfully rendered, I can see the template on the index page (https://antonostrovsky.github.io/test_site/), BUT the Contact link leads to nowhere, resulting in "Not Found" error.

I think I have followed the 'Github Pages' method correctly: my theme repository has 'Gemfile', and the _config.yml contains references to the necessary jekyll gems.

Would you be so kind and help me understand why this is happening?

I have already posted a question on Stack Overflow with a bounty, and went to Jekyll IRC - nobody seems to know what is happening.

Thank you in advance

Display is set to `inline-block` on `catalogue-item`

Hey!

First, thanks for the great theme.

While testing my website I realized that the display property is set to inline-block on the catalogue-item.

This is fine when the post's content is big, but for small/empty posts, it produces the following result on the index.html page:

image

The error seems to go away just by setting the value of the property to block on this line of the _catalogue.scss file.

I would open a PR, but didn't know if this was intentional or not.

Clean up project structure

I thought that it might be a good idea to revise a part of the project's structure and to split some files into smaller modules (head, navigation, footer, etc.).

Functionality should stay the same and is not supposed to be compromised by this process.

What do you think about this?

Post links aren't updating

Hi, this is my first time using Jekyll, so I may just be making a simple mistake. I've forked the repository and have changed all the needed variables in the configurations file. I also changed the base url to /tale. Unfortunately, the links for the posts still link to the posts on your website, instead of reading the config file and linking to my website.

Moving posts list from homepage?

I wanted to create a static front page and move the posts list to, say, a blog page. So far, I've done this:

  • duplicate index.html and save as blog.html
  • rename index.html to index.md
  • create a new nav. item to access blog.html

The issue is accessing the posts listing in blog.html. It seems to be a problem with the paginate-plugin. I get the following error:
Pagination: Pagination is enabled, but I couldn't find an index.html page to use as the pagination template. Skipping pagination.

I've tried to get around the problem by creating a folder blog and an index.html in it but, of course, it didn't help.

Any idea in how to tell the paginate template to look some place else than index.html?

Thank you for your help.

New jekyll update is breaking theme

We no longer include the following libraries with gems or as standard libraries. To use these features, install the corresponding gems.

  • sdbm
  • webrick
  • net-telnet
  • xmlrpc

I have resolved the issue by adding webrick to my Gemfile, but Jekyll should provide a gemspec for it.

New pages in navigation bar

Hello. I want to add a couple more pages to the navigation bar, instead of only About and Posts. How can I do this? Thanks in advance. Great theme.

Not compatible with Jekyll 4

I tried to use with my Jekyll project using em instalation method but bundle could not resolve dependencies:

$ bundle add tale
Resolving dependencies...
Bundler could not find compatible versions for gem "jekyll":
  In snapshot (Gemfile.lock):
    jekyll (= 4.0.0)

  In Gemfile:
    jekyll (~> 4.0.0)

    tale was resolved to 0.1.6, which depends on
      jekyll (~> 3.6)

404 error

Hello
I'm new in jekyll. I forked you repo and add my config to it. when run jekyll on localhost everything is ok. but when i push jekyll to github. i find some issue. first i give you some information about config file
my _config.yml

# Permalinks
permalink:      /:year-:month-:day/:title

# Setup
title:          Tale
paginate:       5
baseurl:        "/"
url:            "" 

# Assets
sass:
  sass_dir:     "../_sass"
  style:        :compressed

# Build settings
markdown:       kramdown

# About
author:
  name:         Chester How
  url:          http://chester.how
  email:        [email protected]

# Custom vars
version:        3.4.1
github:
  repo:         https://github.com/chesterhow/tale

# Gems
gems:
  - jekyll-paginate

I go to this link
https://behroozramezani.github.io/mr.ramezani/
my site load but when i open any post link or open about link i got an error 404
screenshot_20171006_150350

Homepage on Github Pages empty

I'm just trying to switch from Jekyll's default theme to tale. But my homepage is empty on Github Pages despite it working without any errors on local PC.

My Gemfile

source "https://rubygems.org"
gem "tale"
gem "github-pages", group: :jekyll_plugins
group :jekyll_plugins do
  gem "jekyll-feed", "~> 0.6"
end
gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]

Layout on IE

I love this theme.
But layout doesn't look well on IE.

Copyright holder

Am I allowed to change the copyright holder?

Original:

<footer>
      <span>
        &copy; <time datetime="{{ site.time }}">{{ site.time | date: '%Y' }}</time> Chester How. All rights reserved.
      </span>
    </footer>

Original:

<footer>
      <span>
        &copy; <time datetime="{{ site.time }}">{{ site.time | date: '%Y' }}</time> {{ site.author.name }}. All rights reserved.
      </span>
    </footer>

Self-hosted solutions require nginx rewrite

Hey man! Been a while, how's it going?

So I was trying out Jekyll with your theme as a disposable micro-site solution by using a hexadecimal hash as a subdomain. Great minimal theme for simple uses man.

I realise that in your _config.yml, you wrote:

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

you omitted the trailing :output_ext

When running jekyll serve, there is no issue. However, on self-hosted solutions, there may be a problem where the server will attempt to load the .html posts without the extension, and respond with a 404.

I was running with an nginx server behind a load balancer.

What I did was to add the following into the server {} block in the nginx site config:

# Remove trailing .html extension
rewrite ^(/.*)\.html(\?.*)?$ $1$2 permanent;
  
# Remove trailing slashes
rewrite ^/(.*)/$ /$1 permanent; 

This rewrite rule basically permits the omission of the extension in the links.

Perhaps it'd be good to add into the README.md if this is true.

How to add script tag?

I am trying to create a customized 404.html page and add a Javascript script into it but it does not work. Could you help me how to a script to a post layout?

Banner idea

Hello:

I really liked your website, but I really wanted to have a banner(full width). However, as a beginner, I actually don't know how to create a banner on this Jekyll template.

Do you think you might be able to add this feature? @chesterhow

Thank you

Make next and prev arrows the same in home and post page layout

I think it'd be nice to have the next and previous arrows to be the same in both home and post layout:

Currently:
In post: left arrow links to the next page and right arrow links to the prev page.
In home: left arrow links to the prev page and right arrow links to the next page.

I suggest changing the post layout to align with the home page.

excerpt display

hi,

To display excerpts of posts at home page, the function below is used:
{{ post.content | strip_html | truncatewords: 30 }}.

However, the function "truncatewords" does not work for no-english language.
Could you please improve this by using the jekyll default function:
{{ post.excerpt }}

Hi Chester

Hi. how do I use the back ticks for multi line codes?

How can I translate the date to Vietnamese in the article view?

First of all, I would like to thank you for making this beautifully and simply designed Jekyll theme. I love it. I'm still using it right now and don't have the intention of switching to the other themes. But there were a little problem with the date and time next to the "Written by {author_name}" section that I don't really like. When the whole blog is written in Vietnamese, the only part English is that date and time section. Thus making me uncomfortable with the overall looking of the website.

7F9931B3-5FFC-47FA-B874-9135CB3FE604

As you can see in the picture, I want it from "May 27, 2019" to "27 tháng 5 2019" but I don't know how to translate this section. Could you mind helping me solving this problem?

Thank you.


You can also check it out at https://blog.tunnaduong.com/ if you want.

Add cover image

Hi,

First of all, thank you for this great theme! :)

I'd like to ask how can I add a cover image to the posts listed on the home page.

I modified home.html like this:

 <div>
        <p style="float: left;"><img src="{{ post.cover }}" height="200px" width="200px" border="1px"></p>
        
        <time datetime="{{ post.date }}" class="catalogue-time">{{ post.date | date: "%B %d, %Y" }}</time>
        <h1 class="catalogue-title">{{ post.title }}</h1>
        <div class="catalogue-line"></div>

        <p>
            {{ post.content | strip_html | truncatewords: 30 }}
        </p>

 </div>

It works but:

  1. the nice animated horizintal line is covered by the image
  2. it's not responsive

Can you give some hints?

Bundler error using fork method

I tried to set up this repository as a new jekyll site using the fork method. When I run jekyll build or jekyll server I get this error from Bundler:

/Users/myname/.rvm/gems/ruby-2.4.1/gems/bundler-1.16.1/lib/bundler/dsl.rb:87:in `gemspec':  (Bundler::Dsl::DSLError)
[!] ≈ at /Users/myname/work/myproject2/myproject-jekyll/tale. Bundler cannot continue.

 #  from /Users/myname/work/myproject2/myproject-jekyll/tale/Gemfile:4
 #  -------------------------------------------
 #  source "https://rubygems.org"
 >  gemspec
 #  -------------------------------------------
        from /Users/myname/work/myproject2/myproject-jekyll/tale/Gemfile:4:in `eval_gemfile'
        from /Users/myname/.rvm/gems/ruby-2.4.1/gems/bundler-1.16.1/lib/bundler/dsl.rb:47:in `instance_eval'
        from /Users/myname/.rvm/gems/ruby-2.4.1/gems/bundler-1.16.1/lib/bundler/dsl.rb:47:in `eval_gemfile'
        from /Users/myname/.rvm/gems/ruby-2.4.1/gems/bundler-1.16.1/lib/bundler/dsl.rb:12:in `evaluate'
        from /Users/myname/.rvm/gems/ruby-2.4.1/gems/bundler-1.16.1/lib/bundler/definition.rb:35:in `build'
        from /Users/myname/.rvm/gems/ruby-2.4.1/gems/bundler-1.16.1/lib/bundler.rb:135:in `definition'
        from /Users/myname/.rvm/gems/ruby-2.4.1/gems/bundler-1.16.1/lib/bundler.rb:101:in `setup'
        from /Users/myname/.rvm/gems/ruby-2.4.1/gems/jekyll-3.7.2/lib/jekyll/plugin_manager.rb:50:in `require_from_bundler'
        from /Users/myname/.rvm/gems/ruby-2.4.1/gems/jekyll-3.7.2/exe/jekyll:11:in `<top (required)>'
        from /Users/myname/.rvm/gems/ruby-2.4.1/bin/jekyll:23:in `load'
        from /Users/myname/.rvm/gems/ruby-2.4.1/bin/jekyll:23:in `<main>'
        from /Users/myname/.rvm/gems/ruby-2.4.1@global/bin/ruby_executable_hooks:15:in `eval'
        from /Users/myname/.rvm/gems/ruby-2.4.1@global/bin/ruby_executable_hooks:15:in `<main>'

My environment:

Mac OSX 10.13.2
Ruby: ruby 2.4.1p111 (2017-03-22 revision 58053) [x86_64-darwin17]
Jekyll: jekyll 3.7.2
Bundler: Bundler version 1.16.1
rvm: rvm 1.29.3 (latest)

Post title with background image

Overall this is my favorite theme so far, but I'm curious how difficult it would be to modify a post to use an image in the background of a post title, similar to the screenshot below (from janczizikow/sleek/)

image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.