aboutsummaryrefslogtreecommitdiffstats
path: root/gum/README.md
blob: 2a23805342d3d793e62c41c4dca0eb4b5db81b01 (plain) (blame)
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
### What is Gum?

Gum is a clean and responsive theme for [Pelican](https://github.com/getpelican/pelican), based on the [Gumby Framework](http://gumbyframework.com/docs).

### Requirements

* [Pelican](https://github.com/getpelican/pelican)

### Configuration

* Edit your settings file to include the following, if desired (any values left blank won't show up in the theme):

```
GITHUB_URL = ''
TWITTER_URL = ''
FACEBOOK_URL = ''
GOOGLEPLUS_URL = ''
```

This theme uses the latest Google Analytics code, which will be included when the following values are filled out appropriately.

```
GOOGLE_ANALYTICS_ID = ''
GOOGLE_ANALYTICS_SITENAME = ''
```

Alternatively you can use [Piwik](http://piwik.org/) for analytics if you set the following settings, where the URL has to be specified without the leading `https://` and trailing `/`.

```
PIWIK_ID = ''
PIWIK_URL = ''
```

To use Juvia for comments, fill out the following values, again without including the leading `https://` and trailing `/` in the URL.

```
JUVIA_URL = ''
JUVIA_ID = ''
```

To use Disqus, add the Disqus site name via the following variable.

```
DISQUS_SITENAME = ''
```

Other features include:

```
SITESUBTITLE = 'your site subtitle'
```

The following standard Pelican settings are honored:

```
DISPLAY_CATEGORIES_ON_MENU
DISPLAY_PAGES_ON_MENU
DEFAULT_LANG
SOCIAL
```

### Screenshot ###

![screenshot](screenshot.png)

### Credits / Thanks

 * Alexis Metaireau / Pelican
 * Digital Surgeons / Gumby Framework
 * Twitter Bootstrap
 * traeblain for his [makefile](https://gist.github.com/traeblain/4252511) gist for building Pelican on Windows

**MIT Open Source License**

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.