binario/README.md

104 lines
2.9 KiB
Markdown
Raw Normal View History

2018-04-27 07:08:35 +00:00
# Binario [WIP]
2018-04-25 18:30:37 +00:00
**Binario** is a responsive card-based & code-light Hugo theme.
2018-04-26 18:39:01 +00:00
![Binario theme screenshot](https://github.com/vimux/binario/blob/master/images/tn.png)
2018-04-25 18:30:37 +00:00
**Features:**
* Responsive
* Card-based list layout
2018-05-28 06:29:46 +00:00
* Internal Hugo templates for Open Graph and Twitter Cards meta data, Google Analytics, and Disqus comments
* Table of contents
2018-05-25 14:35:12 +00:00
* Related content
2018-05-27 12:01:09 +00:00
* MathJax
2018-04-25 18:30:37 +00:00
2018-04-27 07:08:35 +00:00
## Configuration
### Config.toml example
```toml
baseurl = "/"
2018-05-28 06:29:46 +00:00
title = "Binario"
2018-04-27 07:08:35 +00:00
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
2018-05-28 06:29:46 +00:00
description = "Responsive card-based & code-light Hugo theme" # Description of your site. Used in meta description
2018-04-27 07:08:35 +00:00
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
2018-05-28 06:29:46 +00:00
#dateFormat = "January 02, 2006" # change the format of dates
2018-05-27 11:59:18 +00:00
#toc: true # Enable Table of Contents for all site pages
#tocOpen: true # Open Table of Contents block. Optional
2018-05-27 11:59:18 +00:00
#comments: true # Enable comments for all site pages
#mathjax: true # Enable MathJax for all site pages
2018-05-27 12:01:09 +00:00
#mathjaxPath: "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js" # Specify MathJax path. Optional
2018-05-27 11:59:18 +00:00
#mathjaxConfig: "TeX-AMS-MML_HTMLorMML" # Specify MathJax config. Optional
[Params.Social]
2018-05-28 08:38:52 +00:00
#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"
2018-05-28 06:33:36 +00:00
#medium = "username"
2018-06-11 18:41:16 +00:00
[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", "MANIFEST"]
2018-04-27 07:08:35 +00:00
```
2018-04-25 18:30:37 +00:00
## Contributing
Have a bug? [Please open a new issue](https://github.com/vimux/binario/issues/new).
2018-04-26 18:39:01 +00:00
Pull requests are very welcome too, but please make sure they match the existing [contributing guide](https://github.com/vimux/binario/wiki/contributing).
2018-04-25 18:30:37 +00:00
## License
Binario is licensed under the [MIT License](https://github.com/vimux/binario/blob/master/LICENSE).