98 lines
2.6 KiB
Markdown
98 lines
2.6 KiB
Markdown
# Pickles [](https://travis-ci.org/mismith0227/hugo_theme_pickles) [](https://github.com/mismith0227/hugo_theme_pickles/blob/master/license.md) [](https://github.com/feross/standard)
|
||
|
||
Pickles is a modern, simple and beautiful Hugo theme.
|
||
|
||
|
||
|
||
## 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.
|