~bittercode/pureburn

#Pureburn

Pureburn is a clear and responsive theme for Hugo. It is a fork of the Blackburn theme

#Overview

Based on Yahoo's Pure CSS (v2.0.3)
Fixed sidebar with social links:
- Twitter
- GNU social
- Facebook
- Weibo
- Tumblr
- Instagram
- Flickr
- 500px
- Pinterest
- YouTube
- Vimeo
- Vine
- SlideShare
- LinkedIn
- Xing
- Reddit
- Hacker News
- Sourcehut
- GitHub
- GitLab
- Bitbucket
- Stack Overflow
- Server Fault
- Steam
- MobyGames
- Last.fm
- Discogs
- Keybase
Client-side syntax highlighting by Highlight.js (v10.1.1)
Web analytics by Google Analytics
Comments by Disqus
Icons by Font Awesome (v5.9.0)

See Hugo Quickstart Guide for more information.

#Configuration

Example config.toml:

baseurl = "https://www.example.com/" # Make sure to end baseurl with a '/'
title = "Your site title"
author = "Your name"
# Shown in the side menu
copyright = "&copy; 2020. All rights reserved."
canonifyurls = true
paginate = 10

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

[params]
  # Shown in the home page
  subtitle = "A Hugo Theme"
  brand = "Pureburn"
  googleAnalytics = "Your Google Analytics tracking ID"
  disqus = "Your Disqus shortname"
  # CSS name for highlight.js
  highlightjs = "androidstudio"
  highlightjs_extra_languages = ["yaml"]
  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"]
  # mainSections sets what types of content will appear on the front page
  mainSections = ["post","review"]

  [params.piwikAnalytics]
    siteid = 2
    piwikroot = "//analytics.example.com/"

[menu]
  # Shown in the side menu.
  [[menu.main]]
    name = "Home"
    pre = "<i class='fas fa-home'></i>"
    weight = 1
    identifier = "home"
    url = "/"
  [[menu.main]]
    name = "Posts"
    pre = "<i class='fas fa-list'></i>"
    weight = 2
    identifier = "post"
    url = "/post/"
  [[menu.main]]
    name = "About"
    pre = "<i class='fas fa-user'></i>"
    weight = 3
    identifier = "about"
    url = "/about/"
  [[menu.main]]
    name = "Contact"
    pre = "<i class='fas fa-phone'></i>"
    weight = 4
    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 = "*"
  weibo = "*"
  tumblr = "*"

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

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

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

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

  # Gaming
  steam = "*"
  mobygames = "*"

  # Music
  lastfm = "*"
  discogs = "*"

  # 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 or URLs:

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

It is also possible to override css per page by adding a custom_css param to the front matter.

Add new behaviours by linking to custom JS files or URLs:

[params]
  custom_js = ["js/my.js", "https://cdnjs.cloudflare.com/ajax/libs/zooming/1.4.2/zooming.min.js"]

It is also to override JS per page by adding a custom_js param to the front matter.

#Shortcodes

#pure_table

{{< pure_table
  "columnName1|columnName2|...|columnName99"
  "dataValue1|dataValue2|...|dataValue99"
  "dataValue1|dataValue2|...|dataValue99"
  "dataValue1|dataValue2|...|dataValue99"
  "... and so on"
>}}

where each positional parameter is separated by the vertical bar (i.e., |). The resulting <table> is set to have class="pure-table pure-table-striped".

#fluid_imgs

{{< fluid_imgs
  "class|src|alt"
  "class|src|alt"
  "... and so on"
>}}

where each positional parameter is separated by the vertical bar (i.e., |).

class: specifies a Pure CSS unit class name (required)
src: specifies the URL of an image (required)
alt: specifies an alternate text for an image (optional)

See here for examples.

#fluid_img (obsolete)

#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.

refs

clone