aboutsummaryrefslogtreecommitdiffstats
path: root/graymill/README.md
blob: 0385813e742cf4ff06893897e6135b9caf8d4f30 (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
80
81
82
83
84
85
## Graymill - A minimal Pelican theme.  
  
Graymill is a minimal, responsive theme for the [Pelican](http://blog.getpelican.com/) static site generator. It is based on the [Milligram CSS framework](http://milligram.io/).  

### Demo

See the theme in action at [muchBits](https://muchbits.com)

### Features

* Syntax highlighting for code blocks
* Easy to install
* Minimal/No Javascript (JS is only used in case Google Analytics is enabled).
* Google Analytics Support
* Responsive (Mobile Friendly Test on [Google](https://search.google.com/test/mobile-friendly?utm_source=mft&utm_medium=redirect&utm_campaign=mft-redirect&id=TT7gCU77TVUWMMbu4pmHsg))

## Installation

* Clone the repository:
```python
git clone https://github.com/rn4ir/graymill.git
```
* Create a `THEME` variable in your `pelicanconf.py` file and set its value to the location of ***graymill*** theme, like so:
```python
THEME = 'path/to/graymill'
```

## Custom Variables

(*Please refer to the sample pelicanconf.py contained in this repo for examples*)  
  
The ***Graymill*** theme use the following settings in the `pelicanconf.py`:

### pelicanconf.py

#### Social Icons:
```python
SOCIAL = (('linkedin', 'https://www.linkedin.com/in/username'),
          ('github', 'https://github.com/username'),
          ('twitter', 'https://twitter.com/username'),
          ('facebook', 'https://facebook.com/userid'),
          )
```

#### Pagination:
```python
DEFAULT_PAGINATION = 8
```

#### Home page parameters:

```python
SITEDESCRIPTION = 'your-site's-tagline'
DISPLAY_SUMMARY = True
DISPLAY_PAGES_ON_MENU = True
```

#### Other Settings
```python
FAVICON = 'images/favicon.png'
STATIC_PATHS = ['images', 'extras']
EXTRA_PATH_METADATA = {
    'extras/.htaccess': {'path': '.htaccess'},
    'extras/robots.txt': {'path': 'robots.txt'},
```

#### For local development:
```
SITEURL = 'http://localhost:8000'
```

### publishconf.py

When you are ready to publish your site add the following settings to `publishconf.py` file

```python
SITEURL = 'https://domain-name.tld'

FEED_ALL_ATOM = 'feeds/all.atom.xml'
CATEGORY_FEED_ATOM = 'feeds/%s.atom.xml'

GOOGLE_ANALYTICS = ""
```

For more information on publishing your site, please read the [Pelican publishing docs](http://docs.getpelican.com/en/3.6.3/publish.html)