blob: b8d867f6f6179cb66a15ae32b6409213b663704d (
plain)
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
98
99
100
101
102
103
104
105
106
107
108
|
# 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
* Simple and beautiful theme.
## 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.git
```
## Usage
Use hugo's -t hugo_theme_pickles or --theme=hugo_theme_pickles option with hugo commands. Example:
## Configuration
You may specify following options in `config.toml` of your site to make use of
this theme's features.
```shell
$ hugo server -t hugo_theme_pickles -w -D
```
```toml
baseurl = "Your site URL"
languageCode = "en-us"
Title = "Your site title"
# Copyright notice. This is displayer in the footer.
copyright = "© Copyright notice"
[params]
# Social accounts. Link to these accounts are displayed in the header and
# footer
twitter = "Your Twitter username"
facebook = "Your Facebook username"
instagram = "Your Instagram username"
googleplus = "Your Google+ user id"
github = "Your GitHub username"
npm = "Your npm username"
codepen = "Your CodePen username"
dribbble = "Your Dribbble username"
fiftypx = "Your 500px username" # 500px
flickr = "Your Flickr username"
pinterest = "Your Pinterest username"
tumblr = "Your Tumblr username"
vimeo = "Your Vimeo username"
youtube = "Your YouTube username"
linkedin = "Your LinkedIn username"
# Disqus shortname
disqus = ""
# Google Analytics API key.
ga_api_key = "Your Google Analytics tracking id"
author = "Your Name"
authorwebsite = "example.com"
avatar = "/path/to/avatar"
contact = "Your contact link (ex. mailto:foo@example.com)"
bio = "Your short bio"
# Short subtitle/tagline. This is displayed in the header.
subtitle = "Short subtitle"
# Logo image. This is displayed ogp image.
logo = "/path/to/logo"
```
## 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
## Version
2.0
## License
Open sourced under the MIT license.
|
