binario/README.md
2018-11-26 14:10:09 -05:00

5.6 KiB

Binario [WIP]

Binario is a responsive card-based & code-light Hugo theme.

Demo

Binario theme screenshot

Features:

  • Responsive
  • Card-based list layout
  • Internal Hugo templates for Open Graph and Twitter Cards meta data, Google Analytics, and Disqus comments
  • Table of contents
  • Related content
  • MathJax

Installation

First of all, you will need to install Hugo and create new site. After that, you ready to install Binario.

There are three different ways you can install Binario:

For more information read the Install and Use Themes

In your Hugo site directory, run:

$ git submodule add https://github.com/vimux/binario themes/binario

Next, edit your config.toml configuration file and add parameter:

theme = "binario"

You can read the GitHub documentation for submodules or those found on Git's website for more information

1B. Git clone

In your Hugo site directory, run:

$ git clone https://github.com/vimux/binario themes/binario

Next, edit your config.toml configuration file and add parameter:

theme = "binario"

1C. Download ZIP and manual install

Download ZIP and extract to the themes/binario

Next, edit your config.toml configuration file and add parameter:

theme = "binario"

Configuration

Config.toml example

baseurl = "/"
title = "Binario"
languageCode = "en-us"
paginate = "10" # Number of posts per page
theme = "binario"
disqusShortname = "" # Enable comments by entering your Disqus shortname
googleAnalytics = "" # Enable Google Analytics by entering your tracking id

[Author] # Used in authorbox
  name = "John Doe"
  bio = "John Doe's true identity is unknown. Maybe he is a successful blogger or writer."
  avatar = "img/avatar.png"

[Params]
  description = "Responsive card-based & code-light Hugo theme" # Description of your site. Used in meta description
  opengraph = true # Enable OpenGraph if true
  twitter_cards = true # Enable Twitter Cards if true
  cardsPerRow = 2 # Possible values: 1, 2, 3
  mainSections = ["post"] # Set main page sections
  post_meta = ["date", "categories"] # Enable post meta fields in given order
  dateFormat = "January 02, 2006" # Change the format of dates
  authorbox = true # Show authorbox at bottom of single pages if true
  toc = true # Enable Table of Contents for all site pages
  tocOpen = true # Open Table of Contents block. Optional
  comments = true # Enable comments for all site pages
  related = true # Enable Related content for single pages
  mathjax = true # Enable MathJax for all site pages
  mathjaxPath = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" # Specify MathJax path. Optional
  mathjaxConfig = "TeX-AMS-MML_HTMLorMML" # Specify MathJax config. Optional

[Params.Social]
  email = "example@example.com"
  facebook = "username"
  twitter = "username"
  telegram = "username"
  googleplus = "profileid"
  instagram = "username"
  pinterest = "username"
  vk = "username"
  linkedin = "username"
  github = "username"
  gitlab = "username"
  stackoverflow = "numberid"
  mastodon = "username"
  medium = "username"

[Params.Share] # Post Share block
  facebook = true
  twitter = true
  reddit = true
  telegram = true
  linkedin = true
  googleplus = true
  vk = true
  pocket = true

# Web App Manifest settings
# https://www.w3.org/TR/appmanifest/
# https://developers.google.com/web/fundamentals/web-app-manifest/
[Params.Manifest]
  name = "Binario"
  shortName = "Binario"
  display = "browser"
  backgroundColor = "#2a2a2a"
  themeColor = "#1b1b1b"
  description = "Responsive card-based & code-light Hugo theme"
  orientation = "portrait"
  startUrl = "/"
  scope = "/"

[outputFormats]
  [outputFormats.MANIFEST]
    mediaType = "application/json"
    baseName = "manifest"
    isPlainText = true
    notAlternative = true

[outputs]
  home = ["HTML", "RSS", "MANIFEST"]

Front Matter example

---
title: "Example article title"
date: "2017-08-21"
description: "Example article description"
comments: true # Enable/disable Disqus comments for specific post
authorbox: true # Enable/disable Authorbox for specific post
toc: true # Enable/disable Table of Contents for specific post
mathjax: true # Enable/disable MathJax for specific post
categories:
  - "Category 1"
  - "Category 2"
tags:
  - "Tag"
  - "Another tag"
menu: main # Add page to a main menu
---

Contributing

Have a bug? Please open a new issue.

Pull requests are very welcome too, but please make sure they match the existing contributing guide.

License

Binario is licensed under the MIT License.