It's a trap! Jekyll theme for a great looking site. Used by haacked.com.
Clone or download
Haacked Merge pull request #13 from SeanKilleen/patch-1
Fix minor typo (double colon)
Latest commit 35bc15e Jan 8, 2019

README.md

Haackbar

image

It's a trap! Jekyll theme for a great looking blog. Used by haacked.com (circa 2019).

It's a loose mashup of the Minima theme for Jekyll and the Greyshade theme for Octopress.

Installation

This theme supports being installed as a remote theme on GitHub Pages. No need to copy anything into your site. Just follow these instructions.

The Quick Version

Add this line to the _config.yml of your Jekyll site:

remote_theme: haacked/haackbar

And copy all the relevant settings from the theme's _config.yml. You'll want to hange the values to reflect your website, unless your name just happens to be "Blog Author."

Be sure to check out the customization section for tips on customizing the theme.

Layouts

Refers to files within the _layouts directory, that define the markup for your theme.

  • default.html — The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says {{ content }} and are linked to this file via FrontMatter declaration layout: default.
  • home.html — The layout for your landing-page / home-page / index-page. [More Info.]
  • page.html — The layout for your documents that contain FrontMatter, but are not posts.
  • post.html — The layout for your posts.

Includes

Refers to snippets of code within the _includes directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem.

  • comments.html — Code to add support for comments. Both Disqus and Jekyll Comments are supported.
  • footer.html — Defines the site's footer section.
  • google-analytics.html — Inserts Google Analytics module (active only in production environment).
  • head.html — Code-block that defines the <head></head> in default layout.
  • header.html — Defines the site's main header section. By default, pages with a defined title attribute will have links displayed here.

Sass

Refers to .scss files within the _sass directory that define the theme's styles.

  • haackbar.scss — The core file imported by preprocessed main.scss, it defines the variable defaults for the theme and also further imports sass partials to supplement itself.
  • haackbar/_base.scss — Resets and defines base styles for various HTML elements.
  • haackbar/_layout.scss — Defines the visual style for various layouts.
  • haackbar/_syntax-highlighting.scss — Defines the styles for syntax-highlighting.

Assets

Refers to various asset files within the assets directory. Every file in the theme's assets directory is copied to the assets directory of the generated site, unless there's already the same file.

This directory contains the main.scss that imports sass files from within the _scss directory. This main.scss is what gets processed into the theme's main stylesheet main.css called by _layouts/default.html via _includes/head.html.

This directory can include sub-directories to manage assets of similar type, and will be copied over as is, to the final transformed site directory.

Plugins

haackbar comes with jekyll-seo-tag plugin preinstalled to make sure your website gets the most useful meta tags. See usage to know how to set it up.

Usage

Home Layout

home.html is a flexible HTML layout for the site's landing-page / home-page / index-page.

Main Heading and Content-injection

The home layout will inject all content from your index.md / index.html before the list of posts. This will allow you to include non-posts related content to be published on the landing page under a dedicated heading. We recommended that you title this section with a Heading2 (##).

Usually the site.title itself would suffice as the implicit 'main-title' for a landing-page. But, if your landing-page would like a heading to be explicitly displayed, then simply define a title variable in the document's front matter and it will be rendered with an <h1> tag.

Customization

To override the default structure and style of haackbar, simply create the concerned directory at the root of your site, copy the file you wish to customize to that directory, and then edit the file. e.g., to override the _includes/head.html file to specify a custom style path, create an _includes directory, copy _includes/head.html from haackbar gem folder to <yoursite>/_includes and start editing that file.

The site's default CSS has now moved to a new place within the gem itself, assets/css/main.scss. To override the default CSS, the file has to exist at your site source. Do either of the following:

  • Create a new instance of main.scss at site source.
    • Create a new file main.scss at <your-site>/assets/css/
    • Add the frontmatter dashes, and
    • Add @import "haackbar";, to <your-site>/assets/main.scss
    • Add your custom CSS to the file.
  • Download the file from this repo
    • Create a new file main.scss at <your-site>/assets/css/
    • Copy the contents at assets/main.scss onto the main.scss you just created, and edit away!

Customize navigation links

To include a page (a markdown file with layout: page) in the navigation section of the header, set the include_nav: true property in the front-matter of the page.

Change default date format

You can change the default date format by specifying site.haackbar.date_format in _config.yml.

# haackbar date format
# refer to http://shopify.github.io/liquid/filters/date/ if you want to customize this
haackbar:
  date_format: "%b %-d, %Y"

Enabling comments

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:

  comments:
    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.

Jekyll Comments

Jekyll Comments is a system built by @damieng that relies on pull requests and data files for comments. You'll need to follow the instructions here to set up a receiver. Then you can point your site to the receiver in _config.yml. Make sure comments are enabled too.

  comments:
    enabled: true
    receiver: https://YOUR_RECEIVER_URL/

Social networks

You can add links to the accounts you have on other sites, with respective icon, by adding one or more of the following options in your config:

twitter_username: jekyllrb
github_username:  jekyll
dribbble_username: jekyll
facebook_username: jekyll
flickr_username: jekyll
instagram_username: jekyll
linkedin_username: jekyll
pinterest_username: jekyll
youtube_username: jekyll
googleplus_username: +jekyll
rss: rss

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

Enabling Excerpts on the Home Page

To display post-excerpts on the Home Page, simply add the following to your _config.yml:

show_excerpts: true

Otherwise the home page shows the full contents of each post.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/haacked/haackbar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

Want to hack on this theme? Great! Not only is this repository a Jekyll theme, it's also a sample Jekyll site. You can clone it locally and run it see it in action.

git clone https://github.com/haacked/haackbar
cd haackbar
script/bootstrap
script/server

The script/bootstrap script only needs to be run once to set up your environment.

To test your theme, run script/server (or bundle exec jekyll serve) and open your browser at http://localhost:4000. This starts a Jekyll server using your theme and the contents. As you make modifications, your site will regenerate and you should see the changes in the browser after a refresh.

License

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