#Hux Blog
- We now support a clean and gorgeous SideBar for displaying more info
- Friends is also added as a common feature of a blog theme
- Full-feature Tag support
- UX optimize for mobile used (bunch of
webkit-vender-something) - Typographic optimize for Chinese (font-family, size, weight..)
- Network optimze for China network environment (drop google webfont, use local CDN)
- Using Github Flavored Markdown
- Use DuoShuo as the Disqus-like third party discussion system
- Use Baidu, Tencent/QQ analysis (TODO: support GA)
- Feel free to fork. Appreciated if you keep the theme author link in the footer
- Expect Star if you like or fork this theme ;)
- Any problem or requirement, just open an issue here and I will help you.
- 如果有需要，可以更新一篇中文文档 ;)
If you have jekyll installed, simply run jekyll serve in Command Line
and preview the themes in your browser. You can use jekyll serve --watch to watch for changes in the source files as well.
You can easily get started by modifying _config.yml:
# Site settings
title: Hux Blog # title of your website..
description: ..... # ...
# SNS settings
github_username: huxpro # modify this account to yours
weibo_username: huxpro # and the links in footer will auto-updated.
# Build settings
# paginate: 10 # nums of posts in one page
# Duoshuo settings # Please set your own DuoShuo account.
useDuoshuo: true # Comment and Share
useShare: true # use Comment only. seeing the Share component is depend on Comment so we can NOT use share only.
There are more options you can check out in the Jekyll - Official Site, or you can directly dive into code to find more.
Free free to checkout Markdown files in the _posts/, you will quickly realized how to post your articles with magic Markdown plus this theme:
---
layout: post
title: "Hello 2015"
subtitle: "Hello World, Hello Blog"
date: 2015-01-29 12:00:00
author: "Hux"
header-img: "img/post-bg-2015.jpg"
tags:
- Life
---
If you wanna change code yourself, a Grunt environment is also included. (Thanks to Clean Blog.)
There are a number of tasks it performs like minification of the JavaScript, compiling of the LESS files, adding banners to keep the Apache 2.0 license intact, and watching for changes. Run the grunt default task by entering grunt into your command line which will build the files. You can use grunt watch if you are working on the JavaScript or the LESS.
Try to understand code in _include/, _layouts/, then you can modify Jekyll Liquid template directly to do more creative customization.
Seeing more information may be necessary for you to display, from V1.1, a clean, gorgeous SideBar is added for you, which provide more area for displaying possible modules including Feature Tags, Short About Me, Friends etc. You can enable (it is default enable) this feature by simply config:
# Sidebar settings
sidebar: true
sidebar-feature-tags: true
sidebar-about-description: "your description here"
sidebar-avatar: /img/avatar-hux.jpg # use absolute URL.
We default support Feature Tags, Short About Me, Friends these three modules and you can add your own. The Sidebar is naturally responsive and would be push to bottom in a small screen (<768px), the Short About Me would be also hidden in small screen.
you can disable Feature Tags by removing sidebar-feature-tags and disable Short About Me by removing sidebar-about-description plus sidebar-avatar. More detail of Friends are talking below.
Friends is very common feature of blog seeing the SEO, so I add it in V1.1 release to help that. One of the awesome point of Friends is that it can live without enable sidebar. The Friends would display in the bottom auto when sidebar set to false.
You can just add your friends information in _config.yml with a familiar JSON syntax and everything is done, very easy:
# Friends
friends: [
{
title: "Foo Blog",
href: "http://foo.github.io/"
},
{
title: "Bar Blog",
href: "http://bar.github.io"
}
]
This theme is forked from IronSummitMedia/startbootstrap-clean-blog-jekyll
Thanks Jekyll and Github Pages!