No description
Find a file
2018-11-14 10:03:23 -05:00
archetypes Change default archetype format (toml -> yaml) 2018-04-25 21:59:58 +03:00
exampleSite Add exampleSite config 2018-11-13 15:49:54 -05:00
i18n Add sharing buttons 2018-06-12 09:02:31 +03:00
images Add theme screenshots 2018-04-26 21:39:01 +03:00
layouts Better handling Web Manifest include 2018-11-14 10:03:23 -05:00
static Update CSS reset 2018-11-14 09:57:56 -05:00
.editorconfig Initial commit 2018-02-09 18:57:24 +03:00
.gitignore Initial commit 2018-02-09 18:57:24 +03:00
.stylelintrc Update .stylelintrc 2018-11-01 11:53:43 -04:00
.travis.yml Add Travis CI 2018-11-01 12:20:47 -04:00
CONTRIBUTING.md Update CONTRIBUTING.md 2018-07-29 14:50:35 +03:00
LICENSE LICENSE.md -> LICENSE 2018-04-25 21:29:37 +03:00
package-lock.json Improve dev workflow 2018-11-01 12:20:14 -04:00
package.json Improve dev workflow 2018-11-01 12:20:14 -04:00
README.md Update CSS reset 2018-11-14 09:57:56 -05:00
theme.toml Bump Hugo version [0.33 -> 0.38] 2018-06-18 22:20:51 +03:00

Binario [WIP]

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

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

[Params]
  author = "John Doe" # Used in meta author. Optional
  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
  dateFormat = "January 02, 2006" # change the format of dates
  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
  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"]

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.