salgnt / travelogue

A minimal, single-column Jekyll theme that provides an immersive read experience for your readers.

Travelogue

   

Travelogue is a minimal, single-column Jekyll theme that provides an immersive read experience for your readers.

Getting Started

The theme provides a complete Jekyll setup. Download it and start the Jekyll server.

git clone https://github.com/SalGnt/Travelogue.git
cd Travelogue
jekyll serve

Visit the Jekyll website for more information.

Features

• Minimal, content focused design;
• Responsive and mobile friendly;
• Integrated slideshow activated on page scroll;
• Customizable share buttons;
• Disqus integration;

Sidebar

A link of each page will be added to the menu integrated in the sidebar.

Post Thumbnail

The thumbnail can be added by specifying a path to an image in the front matter.

thumb: http://yourdomain.com/public/images/post_title/thumb.jpeg

Backgrounds

The theme has an integrated slideshow. Its control is attached to the scroll action on the page, as shown in the original concept.

You can add one or more backgrounds in the front matter by using the syntax shown below.

backgrounds:
    - http://yourdomain.com/public/images/post_title/background_01.jpeg
    - http://yourdomain.com/public/images/post_title/background_02.jpeg
    - http://yourdomain.com/public/images/post_title/background_03.jpeg
    - ...

Info

All the details about a post are located after its content. Tags and categories can be hidden by adding the following variables in the front matter.

show_tags: false
show_categories: false

You can also specify the author's name for each post by adding the following variable in the front matter.

author: John Doe

Share Buttons

The template make use of RRSSB. You can enable it in the _config.yml file.

share_buttons: true

If you want you can also enable or disable each share button by editing the # RRSSBB section in the _data/social.yml file.

Disqus

The template let you use Disqus. You can enable it in the _config.yml file.

disqus: true

You should set your Disqus shortname under the # Disqus section in the _data/social.yml file.

Next Post

A link to the next post will be placed at the end of each post.

Authors

Dmitry Zelinsky (Designer)

• Dribbble
• Twitter

Salvatore Gentile (Developer)

• GitHub
• Twitter
• Dribbble

License

The theme is released under The MIT License (MIT).

The MIT License (MIT)

Copyright (c) 2015 Salvatore Gentile

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

travelogue's Issues

Add Loading Indicator

A loading indicator for the slideshow should be added.

Automate Tasks

The production environment needs to be automated. I'm thinking of using Grunt in combination with Bower.

Add Archive

If border is changed from 10px responsiveness of index page stops working

Thanks for a great theme!

I was trying to customize the theme to remove the boarders between the posts in the post listing at the index page.

Changing _layout.scss:

.post-list {
    > li {
        border: 10px solid transparent;

To this

.post-list {
    > li {
        border: 0px solid transparent;

But then it seems the resonsive function broke down and if you shrink the screen to mobile size it doesn't stack the post on top of each other like it normally does instead it just tries to make the posts much smaller which mean you can't see anything.

What it looks like

The issue remains when you use a border of less then 10px but not if you use 10px

I'm sure there is a simple solution that I missed.

border-radius not working for .post-thumb

I have an Android 5.0.2 using the latest Chrome and the .post-thumb does not have any border-radius when you go inside a post.

This has - of course nothing to do with the code quality of "Travelogue", it's a general CSS issue on Androids, I guess. For the moment I fixed this by reducing the width/height of the <img /> for mobile only

@include media-query($on-palm) {
  width: 160px;
  height: 160px;
}

Add Pagination

The template needs a better management for the items in the home page.

Add Disqus

tags & categories

greetings. tags and categories don't show up despite it's turned on in config.

Add 404 Page

Build Failure in both Ubuntu 14.4 and Windows 7

Actually I solved the this problem, but still don't know if this comes from update of Jekyll or something else.
I tried to build this template under Ubuntu 14.4 (Ruby 2.1 + Jekyll 2.5.3) and Windows (Ruby 1.9/2.0 + Jekyll 2.5.3), both of which gives plugin-load error:

xiaoke@caunion:~/Travelogue$ jekyll serve
Configuration file: /home/xiaoke/Travelogue/_config.yml
/usr/local/lib/site_ruby/2.1.0/rubygems/core_ext/kernel_require.rb:121:in `require': cannot load such file -- jekyll-sitemap (LoadError)
        from /usr/local/lib/site_ruby/2.1.0/rubygems/core_ext/kernel_require.rb:121:in `require'
        from /var/lib/gems/2.1.0/gems/jekyll-2.5.3/lib/jekyll/plugin_manager.rb:29:in `block in require_gems'
        from /var/lib/gems/2.1.0/gems/jekyll-2.5.3/lib/jekyll/plugin_manager.rb:26:in `each'
        from /var/lib/gems/2.1.0/gems/jekyll-2.5.3/lib/jekyll/plugin_manager.rb:26:in `require_gems'
        from /var/lib/gems/2.1.0/gems/jekyll-2.5.3/lib/jekyll/plugin_manager.rb:19:in `conscientious_require'
        from /var/lib/gems/2.1.0/gems/jekyll-2.5.3/lib/jekyll/site.rb:79:in `setup'
        from /var/lib/gems/2.1.0/gems/jekyll-2.5.3/lib/jekyll/site.rb:41:in `initialize'
        from /var/lib/gems/2.1.0/gems/jekyll-2.5.3/lib/jekyll/commands/build.rb:29:in `new'
        from /var/lib/gems/2.1.0/gems/jekyll-2.5.3/lib/jekyll/commands/build.rb:29:in `process'
        from /var/lib/gems/2.1.0/gems/jekyll-2.5.3/lib/jekyll/commands/serve.rb:26:in `block (2 levels) in init_with_program'
        from /var/lib/gems/2.1.0/gems/mercenary-0.3.5/lib/mercenary/command.rb:220:in `call'
        from /var/lib/gems/2.1.0/gems/mercenary-0.3.5/lib/mercenary/command.rb:220:in `block in execute'
        from /var/lib/gems/2.1.0/gems/mercenary-0.3.5/lib/mercenary/command.rb:220:in `each'
        from /var/lib/gems/2.1.0/gems/mercenary-0.3.5/lib/mercenary/command.rb:220:in `execute'
        from /var/lib/gems/2.1.0/gems/mercenary-0.3.5/lib/mercenary/program.rb:42:in `go'
        from /var/lib/gems/2.1.0/gems/mercenary-0.3.5/lib/mercenary.rb:19:in `program'
        from /var/lib/gems/2.1.0/gems/jekyll-2.5.3/bin/jekyll:20:in `<top (required)>'
        from /usr/local/bin/jekyll:23:in `load'
        from /usr/local/bin/jekyll:23:in `<main>'

Solution:
After inspection, I found the loading process crashed when loading "jekyll-sitemap". So users who meet similar problem can solve this by

gem install jekyll-sitemap

I'm not sure why this plugin has not been included, given that I followed standard jekyll install process. Is this plugin just removed from required dependencies or it was not since the beginning? If it is the latter, I think it might be a good idea to note this in README or somewhere.

This little problem is quite annoying for jekyll new users like me, since "--verbose" parameter will not output the "Jekyll.logger.debug" info and there is nowhere for me to find the log file to know what specific plugin has failed to load (If there is, pls tell me). My solution is to dump all loaded plugin to a file.

Add Share Buttons for Posts

Unreadable Posts Details

On certain screen resolutions the details of the posts shown on the home page become unreadable.