1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
# Pickles [![Build Status](https://travis-ci.org/mismith0227/hugo_theme_pickles.svg?branch=master)](https://travis-ci.org/mismith0227/hugo_theme_pickles) [![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/mismith0227/hugo_theme_pickles/blob/master/license.md) [![Standard - JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
Pickles is a modern, simple and beautiful Hugo theme.
![screenshot](https://github.com/mismith0227/hugo_theme_pickles/blob/master/images/screenshot.png)
## Overview
* Modern, Simple and beautiful design
* Medium's Image Zoom([zoom.js](https://github.com/fat/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:
```shell
$ mkdir themes
$ cd themes
$ git clone -b release https://github.com/mismith0227/hugo_theme_pickles
```
Or download it from the release branch
[release](https://github.com/mismith0227/hugo_theme_pickles/tree/release)
## Usage
Use hugo's -t hugo_theme_pickles or --theme=hugo_theme_pickles option with hugo commands. Example:
```shell
$ 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](https://github.com/mismith0227/hugo_theme_pickles/blob/master/exampleSite/config.toml) file from the exampleSite directory inside Pickles’s repository to your site repository.
```shell
$ 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](https://github.com/mismith0227/hugo_theme_pickles/tree/develop) and submit a PR for any change.
## Development
1. Install Node modules
$ yarn
1. 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.
|