diff options
author | surajmandalcell <surajmandalcell@gmail.com> | 2018-04-03 12:51:11 +0300 |
---|---|---|
committer | surajmandalcell <surajmandalcell@gmail.com> | 2018-04-03 12:51:11 +0300 |
commit | cef871ce3d682214f66b8e13fe7b9dd6181a9b1a (patch) | |
tree | c983e3926c208d854c7fd01c33bc1245b78d988c /README.md | |
parent | a32e83577ee5f3bbdd5e040888f76a0e590a1ec3 (diff) |
update css
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..efa2bfb --- /dev/null +++ b/README.md @@ -0,0 +1,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. |