| archetypes | ||
| data | ||
| exampleSite | ||
| i18n | ||
| images | ||
| layouts | ||
| static | ||
| .editorconfig | ||
| .gitignore | ||
| .stylelintrc | ||
| .travis.yml | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| theme.toml | ||
Binario [WIP]
Binario is a responsive card-based & code-light Hugo theme.
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
Table of Contents
Installation
First of all, you will need to install Hugo and create new site. Also, you have git installed on your machine and you are familiar with basic git usage. After that, you ready to install Binario.
There are three different ways you can install Binario. Choose one of the installation methods listed below and follow the instructions.
For more information read the "Install and Use Themes".
Option A. 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"
Option B. Git submodule
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
Option C. 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"
You can run your site in Hugo server mode:
hugo server
Now you can go to localhost:1313 webpage and the Binario theme should be visible.
After you make sure that Binario works, you may start customizing the theme if it's needed. You can change number of columns, activate footer social icons, share buttons and much more.
Configuration
Hugo uses the config.toml, config.yaml, or config.json (if found in the site root) as the default site config file. Here is Binario configuration example in TOML with all available theme-specific config params:
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
copyright = "Binario" # Copyright holder, otherwise will use .Site.Title
opengraph = true # Enable OpenGraph if true
twitter_cards = true # Enable Twitter Cards if true
columns = 2 # Set the number of cards columns. 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
customCSS = ["css/custom.css"] # Include custom CSS files
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
relatedMax = 5 # Set the maximum number of posts that can be displayed in related block. Optional
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
hideNoPostsWarning = false # Don't show no posts empty state warning in main page, if true
[Params.Social]
email = "example@example.com"
facebook = "username"
twitter = "username"
telegram = "username"
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
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"]
For more information about Hugo configuration files and all common configuration settings, please read "Configure Hugo" from Hugo official documentation.
Front Matter example
Hugo supports three formats for front matter: yaml, toml and json. Here is Front Matter example in YAML:
---
# Common-Defined params
title: "Example article title"
date: "2017-08-21"
lastmod: "2018-12-21"
description: "Example article description"
categories:
- "Category 1"
- "Category 2"
tags:
- "Tag"
- "Another tag"
menu: main # Add page to a menu. Options: main, footer
# Theme-Defined params
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
related: true # Enable/disable Related content for specific post
---
For more information about front matter variables and formats read "Hugo Front Matter" from Hugo official documentation.
Configuration options
Binario includes some customizable configuration options that may be useful.
Columns
By default, Binario works with two columns layout (if it possible by screen size) for list pages, but you can also use one column or three columns layout. Change Params.columnsto preferable value (from 1 to 3). You can also change this option for specific list pages.
Custom CSS
If you want to include custom CSS files, you need to assign an array of references in site config file (config.toml by default) like following:
[Params]
customCSS = ["css/custom.css"]
Of course, you can reference as many CSS files as you want. Their paths need to be relative to the static folder of your Hugo site:
[Params]
customCSS = ["css/custom.css", "css/another.css"]
All these CSS files will be added through the head.html partial after the built-in CSS file.
Post Meta
You may activate post meta fields with .Site.Params.post_meta parameter.
Related Content
Binario uses default Related Content Hugo feature to provide "See Also"-like section. You can activate "Related Content" section with .Site.Params.related parameter.
More information available at Hugo Related Content
Share Buttons
To display share buttons, set up [Params.Share] specific parameters in your site config file.
Available share buttons: Facebook, Twitter, Reddit, Telegram, LinkedIn, VK, Pocket
Thumbnail Image
You can add thumbnail image to your content page. Just put thumbnail.* image file in page bundle.
Footer Social Icons
With Binario, you have the option to display social icons in the footer. To display them, set up [Params.Social] specific parameters in your site config file.
Available social services: Email, Facebook, Twitter, Telegram, Instagram, Pinterest, VK, LinkedIn, GitHub, GitLab, Stack Overflow, Mastodon, Medium
Web App Manifest
Web App Manifest is a simple json file with basic site info like name, description, icons, etc. This file tells the browser about your web application and how it should behave when "installed" (as PWA) on the users mobile device or desktop.
To activate Web App Manifest you need to define MANIFEST custom output format & specify [Params.Manifest] parameters in your site config file.
First of all, you should define MANIFEST custom output format [config.toml]:
[outputFormats]
[outputFormats.MANIFEST]
mediaType = "application/json"
baseName = "manifest"
isPlainText = true
notAlternative = true
Then, include MANIFEST output format for home Kind attribute [config.toml]:
[outputs]
home = ["HTML", "RSS", "MANIFEST"]
After that, you can specify [Params.Manifest] parameters.
To verify that your manifest file is configured properly and works well, run Hugo server and open Chrome DevTools (Press F12 in Chrome) → Application → Manifest
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.
- Social media icons based on SuperTinyIcons [MIT]
- CSS Reset based on Bootstrap Reboot [MIT]