Skip to content

cqu-lug/hugo-theme-pixyll

 
 

Repository files navigation

Pixyll

Pixyll is a simple, beautiful theme for Hugo. Based on Pixyll for Jekyll

Features

  • Basic tag support.
  • Disqus comments supported.
  • Google Analytics supported.
  • Social links (currently only for twitter).
  • Formspree for contact form.
  • Pagination support.
  • 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:

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 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.
  2. Install python requirements: pip install -r requirements.txt
  3. 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

Releases

No releases published

Packages

No packages published

Languages

  • CSS 87.2%
  • HTML 8.2%
  • JavaScript 2.8%
  • Python 1.8%