Welcome to mirror list, hosted at ThFree Co, Russian Federation.

README.md - github.com/azmelanar/hugo-theme-pixyll.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: f5346db8a7c5ff42bc6fdd6d43a184a00a89e429 (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
# Pixyll

Pixyll is a simple, beautiful theme for [Hugo](http://gohugo.io/).
Based on [Pixyll for Jekyll](https://github.com/johnotander/pixyll)

## Features

- Basic tag support.
- Disqus comments supported.
- Google Analytics supported.
- Social links (currently only for twitter).
- [Formspree](http://formspree.io/) for contact form.
- Pagination support.
- [Search](#search), executes in client side javascript.

NOTE: Content under `content/posts` is not rendered with this theme! Please move your content to `content/post`. 

Example config:

```toml
languageCode = "en-us"
contentdir = "content"
publishdir = "public"
builddrafts = false
baseUrl = ""
canonifyurls = true
title = "Pixyll"
author = "admin"
theme = "pixyll"
disqusShortname = "sitename"

[indexes]
  category = "categories"
  tag = "tags"

[params]
  search_engine = true
  google_analytics_id = "XX-XXXXXXXX-X"
  twitter_username = "username"
  paginate = true
```

## Search
We decided to use [Tipue Search](http://www.tipue.com/search/) with custom script
to generate index. Search is being done completely in browser, you don't need to
run webserver for search. Current version of Tipue Search is 7.0

To activate search ensure that `[params]` section has line `search_engine = true`.
Then you need to generate search index:
1. Copy script `create_search_index.py` to your website root location,
where `config.toml` is located.
1. Install python requirements: `pip install -r requirements.txt`
1. Run `python2 create_search_index.py`

Script was tested with python 2.7 only.

Index will be placed into `public/tipuesearch/tipuesearch_content.js`. Every time you add
new article you need to regenerate index with command above.
If you run hugo as a server, please append option `--renderToDisk` othervise hugo
will not pick up files generated by search script.

![Pixyll Screenshot](https://raw.githubusercontent.com/azmelanar/hugo-theme-pixyll/master/images/tn.png)