Yab

Gem Version

Yab is Yet Another (Jekyll) Bootstrap theme. Its style is similar to Jekyll Bootstrap.
In fact, Jekyll Bootstrap isn't compatible with latest Jekyll, so I make this theme.

Features

Now (0.3.2)

  • Categories page
  • Archives page
  • Tags page
  • Subtitle (tagline)
  • Friend links
  • Google Analytics
  • Disqus

Comming soon

  • Quickly deploy to GitHub Pages repository (auto-copy)
  • More comments services
  • Posts pagination
  • Internationalization (i18n) support

Installation

Add this line to your Jekyll site's Gemfile:

gem "yab"

And add these lines to your Jekyll site's _config.yml:

theme: yab

gems:
  - jekyll-sitemap
  - jekyll-bootstrap-sass
  - jekyll-feed

bootstrap:
  assets: true

feed:
  path: feed.xml

And then execute:

$ bundle

At last, create (or update if already exists) the CSS entrypoint at site source .

  • Create a new file main.scss at <your-site>/assets/
  • Add the frontmatter dashes, and
  • Add $icon-font-path: "{{ site.github.url }}/assets/fonts/bootstrap/"; @import "yab";, to <your-site>/assets/main.scss
  • Then add your custom CSS.

Usage

Some tips, make things easier:

  • site.url doesn't end with /
  • Single / for site.baseurl is NOT recommended, use `` (blank) instead.

Enabling feed (via jekyll-feed)

To enable it, add the following lines to your Jekyll site: (even if you want use default path) 

feed:
  path: feed.xml

Enabling comments (via Disqus)

Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.

To enable it, add the following lines to your Jekyll site:

disqus:
  shortname: my_disqus_shortname

You can find out more about Disqus' shortnames here.

Comments are enabled by default and will only appear in production, i.e., JEKYLL_ENV=production

If you don't want to display comments for a particular post you can disable them by adding comments: false to that post's YAML Front Matter.

--

Enabling Google Analytics

To enable Google Anaytics, add the following lines to your Jekyll site:

google_analytics: UA-NNNNNNNN-N

Google Analytics will only appear in production, i.e., JEKYLL_ENV=production

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/techotaku/yab.

License

The theme is available as open source under the terms of the MIT License.