Modern, Simple and beautiful Hugo theme
Clone or download
Latest commit ad04d2e Oct 13, 2018

README.md

Pickles Build Status license Standard - JavaScript Style Guide

Pickles is a modern, simple and beautiful Hugo theme.

screenshot

Overview

  • Modern, Simple and beautiful design
  • Medium's Image Zoom(zoom.js)
  • Social links(Twitter,Facebook,Instagram,Google+,GitHub,GitLab,npm,Codepen,Dribbble,500px,Flickr,Pinterest,Tumblr,Vimeo,YouTube,Linkedin)
  • Support for Related Content
  • Support for tags
  • Analytics with Google Analytics
  • Responsive design
  • SVG Sprite

Use short code for Image Zoom.

{{% zoom-img src="/images/default.jpg" %}}

Features

  • gulp
  • webpack
  • PostCSS
  • Babel
  • SVG Sprite
  • Standard

Installation

In your hugo site directory, run:

$ mkdir themes
$ cd themes
$ git clone -b release https://github.com/mismith0227/hugo_theme_pickles

Or download it from the release branch

release

Usage

Use hugo's -t hugo_theme_pickles or --theme=hugo_theme_pickles option with hugo commands. Example:

$ hugo server -t hugo_theme_pickles -w -D

Configuration

You may specify following options in config.toml of your site to make use of this theme's features.

For getting started with Pickles, copy the config.toml file from the exampleSite directory inside Pickles’s repository to your site repository.

$ cp themes/hugo_theme_pickles/exampleSite/config.toml .

Now, you can start editing this file and add your own information!

Contributing

Pull requests, bug fixes and new features are welcome!

Please create feature branches from develop and submit a PR for any change.

Development

  1. Install Node modules

     $ yarn
    
  2. Run gulp. You don't need to install gulp globally.

     // Development
     $ yarn run dev
     $ // On another tab
     $ hugo server
    
     // Production (compress)
     $ yarn run prod
     $ // On another tab
     $ hugo server
    
     // Build
     $ yarn run build
    

License

Open sourced under the MIT license.