ominux / blackburn

A Hugo theme built using Yahoo's Pure CSS

Blackburn

Blackburn is a clear and responsive theme for Hugo.

Overview

• Based on Yahoo's [Pure CSS] (http://purecss.io/) (v0.6.0)
• Fixed sidebar with social links:
  • Twitter
  • GNU social
  • Facebook
  • Google+
  • Weibo
  • Instagram
  • Flickr
  • Pinterest
  • YouTube
  • Vimeo
  • Vine
  • SlideShare
  • LinkedIn
  • Xing
  • Reddit
  • Hacker News
  • GitHub
  • Bitbucket
  • Stack Overflow
  • Server Fault
  • Steam
  • Last.fm
  • Keybase
• Client-side syntax highlighting by Highlight.js (v9.1.0)
• Web analytics by Google Analytics
• Comments by Disqus
• Icons by Font Awesome (v4.5.0)

Demo

• Demo
• You can also see it in action on my personal website here

Screenshots

Installation

In your Hugo site directory, run:

$ mkdir themes
$ cd themes
$ git clone https://github.com/yoshiharuyamashita/blackburn.git

or download from here.

See Hugo Quickstart Guide for more information.

Configuration

Example config.toml:

baseurl = "http://replace-this-with-your-hugo-site.com/"
title = "Your site title"
author = "Your name"
# Shown in the side menu
copyright = "© 2016. All rights reserved."
canonifyurls = true
paginate = 10

[indexes]
  tag = "tags"
  topic = "topics"

[params]
  # Shown in the home page
  subtitle = "A Hugo Theme"
  brand = "Blackburn"
  googleAnalytics = "Your Google Analytics tracking ID"
  disqus = "Your Disqus shortname"
  # CSS name for highlight.js
  highlightjs = "androidstudio"
  dateFormat = "02 Jan 2006, 15:04"
  # Include any custom CSS and/or JS files
  # (relative to /static folder)
  custom_css = ["css/my.css"]
  custom_js = ["js/my.js"]

[menu]
  # Shown in the side menu.
  [[menu.main]]
    name = "Home"
    pre = "<i class='fa fa-home fa-fw'></i>"
    weight = 0
    identifier = "home"
    url = "/"
  [[menu.main]]
    name = "Posts"
    pre = "<i class='fa fa-list fa-fw'></i>"
    weight = 1
    identifier = "post"
    url = "/post/"
  [[menu.main]]
    name = "About"
    pre = "<i class='fa fa-user fa-fw'></i>"
    weight = 2
    identifier = "about"
    url = "/about/"
  [[menu.main]]
    name = "Contact"
    pre = "<i class='fa fa-phone fa-fw'></i>"
    weight = 3
    url = "/contact/"

[social]
  # Link your social networking accounts to the side menu
  # by entering your username or ID.

  # SNS microblogging
  twitter = "*"
  gnusocial = "*" # Specify href (e.g. https://quitter.se/yourusername)
  facebook = "*"
  googleplus = "*"
  weibo = "*"

  # SNS photo/video sharing
  instagram = "*"
  flickr = "*"
  pinterest = "*"
  youtube = "*"
  vimeo = "*"
  vine = "*"
  slideshare = "*"

  # SNS career oriented
  linkedin = "*"
  xing = "*"

  # SNS news
  reddit = "*"
  hackernews = "*"

  # Techie
  github = "yoshiharuyamashita"
  bitbucket = "*"
  stackoverflow = "*"
  serverfault = "*"

  # Gaming
  steam = "*"

  # Music
  lastfm = "*"

  # Other
  keybase = "*"

Usage

• Write Markdown files in content/post
• Add fixed pages (e.g., about.md) to the side menu by defining them under [menu] in the config.toml:

[[menu.main]]
  name = "About"
  pre = "<i class='fa fa-user fa-fw'></i>"
  weight = 2
  identifier = "about"
  url = "/about/"

• Override the theme by linking to custom CSS files:

[params]
  custom_css = ["css/my.css"]

• Add new behaviours by linking to custom JS files:

[params]
  custom_js = ["js/my.js"]

Shortcodes

Positional

{{% fluid_img "/path/to/img" %}}

Named

{{% fluid_img class="pure-u-1-2" src="/path/to/img" alt="img description" %}}
{{% fluid_img class="pure-u-1-3" src="/path/to/img" caption="img description" %}}

• class, alt and caption are optional.
• See Pure CSS Grids for possible class values.

License

• MIT