Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/rockbenben/rockbenben.github.io

Jekyll 博客源文件
https://github.com/rockbenben/rockbenben.github.io

Last synced: about 2 months ago
JSON representation

Jekyll 博客源文件

Awesome Lists containing this project

README 

        
# Hux Blog



### [View Live Hux Blog →](https://huangxuan.me)



![](http://huangxuan.me/img/blog-desktop.jpg)



## Boilerplate (beta)



Want to clone a boilerplate instead of my buzz blog? Here comes this!  



```

$ git clone [email protected]:Huxpro/huxblog-boilerplate.git

```



**[View Boilerplate Here →](http://huangxuan.me/huxblog-boilerplate/)**



## Porting 



- [**Hexo**](https://github.com/Kaijun/hexo-theme-huxblog) by @kaijun

- [**React-SSR**](https://github.com/LucasIcarus/huxpro.github.io/tree/ssr) by @LucasIcarus



## Translation



 - ![cn](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/China.png) **Chinese (Simplified)**: 感谢 [@BrucZhaoR](https://github.com/BruceZhaoR) 的 [中文翻译 →](https://github.com/Huxpro/huxpro.github.io/blob/master/README.zh.md)



## Releases



##### V1.8



- Brand new [Archive](https://huangxuan.me/archive/) page! Which is not just serving as common archive page but also Tag page where all posts are filter-able with tags!

Thanks [@kitian616/jekyll-TeXt-theme](https://github.com/kitian616/jekyll-TeXt-theme) to bring this brilliant idea. Noted that the old Tag page and Archive page are deprecated but the new archive's totally backward compatiable.

- Re-engineering of the blog by extracting duplicated liquid templates. This was proposed in #74 by @Kaijun but postponed for entirely 2.5 years! I wasn't able to merge his PR directly because of long-time divegence but I'd love to give him the full credit! 

- New code block! Long-wanted line number are supported out of the box now (thanks for @SmilingParadise's help on Sina Weibo) and the theme was updated to Atom One Dark (checkout FQA for how to change to your farovite theme)

- MathJax support by @Voleking in #80, but I choose the SVG renderer. See [Mathjax, kramdown and Octopress](https://www.lucypark.kr/blog/2013/02/25/mathjax-kramdown-and-octopress/) for writing and escaping details.

- Open Graph Protocol support by @Android-KitKat in #253

- `header-img-credit` and `header-img-credit-href`

- `nav-style: invert` and `header-style: text`



##### V1.7



- PWA / Service Worker



##### v1.6



- change cdn to cdnjs for better HTTPS support



##### V1.5.2



- Annoyed to delete my blog post after clone or pull? **Boilerplate** comes to help you get started quickly and easily merge update.

- `-apple-system` is added in font rule, which display beautiful new font **San Francisco** in iOS 9 by default.

- Fixed [issue#15](https://github.com/Huxpro/huxpro.github.io/issues/15) about code wrap.



##### V1.5.1



- **[Comment](#comment)** support [**Disqus**](http://disqus.com) officially, thanks to @rpsh.



##### V1.5



- **[Comment](#comment)** and **[Analytics](#analytics)** is configurable now! We also add **Google Analytics support** and drop tencents. Both documents is updated.



##### V1.4



- **[Featured Tags](#featured-tags)** is now independent of [SideBar](#sidebar). Both documents is updated.

- New **[SEO Title](#seo-title)** for SEO usage which is differ from the site title



##### V1.3.1



- Support **PingFang (苹方)**, the new Chinese font presented by [OS X El Capitan](http://www.apple.com/cn/osx/whats-new/)



##### V1.3



- Big Improvement to the **Navigation Menu** *(especially in Android)*:  Dropping the old, stuttering, low-performance [Bootstrap collapse.js](http://getbootstrap.com/javascript/#collapse),  replaced with an own wrote, [jank free](http://jankfree.org/) navbar menu in a pretty high-performance implementation of [Google Material Design](https://www.google.com/design/spec/material-design/introduction.html).






##### V1.2



- Brand new **[Keynote Layout](#keynote-layout)** is provided for easily posting beautiful HTML presentations you have created with this blog



##### V1.1



- We now support a clean and gorgeous **[SideBar](#sidebar)** for displaying more info

- **[Friends](#friends)** is also added as a common feature of blog help you do SEO



##### V1.0



- Full-feature **Tag** support

- **Mobile first** user experience optimization

- **Typographic optimization** for Chinese Fonts

- **Network optimizaition** for China, dropping Google webfont, using local CDN

- Using [Github Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/)

- Using Baidu, Tencent/QQ analytics

- Using [DuoShuo](http://duoshuo.com/) as the Disqus-like third party discussion system



## Support



- **Feel free to fork. I'll Appreciate it if you keep the Author & Github link at footer**

- Give it a **Star** if you like, fork or just clone to use ;)

- If any problem or requirement, just open an issue here and I will help you.



## Document



* Get Started

	* [Environment](#environment)

	* [Get Started](#get-started)

	* [Write Posts](#write-posts)

* Components

	* [SideBar](#sidebar)

	* [Mini About Me](#mini-about-me)

	* [Featured Tags](#featured-tags)

	* [Friends](#friends)

	* [Keynote Layout](#keynote-layout)

* Comment & Analysis

	* [Comment](#comment)

	* [Analytics](#analytics)

* Advanced

	* [Customization](#customization)

	* [Header Image](#header-image)

	* [SEO Title](#seo-title)

	* [Page Build Warning](#page-build-warning)

* FAQ



#### Environment



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.



#### Get Started



You can easily get started by modifying `_config.yml`:



```

# Site settings

title: Hux Blog             # title of your website

SEOTitle: Hux Blog			# check out docs for more detail

description: "Cool Blog"    # ...



# SNS settings      

github_username: huxpro     # modify this account to yours

weibo_username: huxpro      # the footer woule be auto-updated.



# Build settings

# paginate: 10              # nums of posts in one page

```



There are more options you can check out in the [Jekyll - Official Site](http://jekyllrb.com/), or you can directly dive into code to find more.



#### Write Posts



Feel free to checkout Markdown files in the `_posts/`, you will quickly realized how to post your articles with magical markdown plus this nice theme.



The **front-matter** of a post looks like that:



```

---

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

---



```



#### SideBar



![](http://huangxuan.me/img/blog-sidebar.jpg)



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. You can enable *(it is default enable)* this feature by simply config:



```

# Sidebar settings

sidebar: true

sidebar-about-description: "your description here"

sidebar-avatar: /img/avatar-hux.jpg     # use absolute URL.

```



We default support *[Featured Tags](#featured-tags)*, *[Mini About Me](#mini-about-me)* and *[Friends](#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 size (`<= 992px`, according to [Bootstarp Grid System](http://getbootstrap.com/css/#grid))  

More details of these three separate modules are talking below.



#### Mini About Me



Mini-About-Me module display all your SNS buttons also your avatar and the description if you set `sidebar-avatar` and `sidebar-about-description` which is very useful and common for a sidebar so it is default with your sidebar.



It is really nice-looking and well-designed. It would be hidden in a small screen seeing the sidebar would be push to bottom and there is already a footer including SNS feature which is similar.



#### Featured Tags



Considering the Featured-Tags feature in [Medium](http://medium.com) is pretty cool, so I add it in my blog theme also.   

This module is independent of sidebar from V1.4, so it can definitely live without enable sidebar, which would be displayed in the bottom when `sidebar` set to false, and it is not only displayed in home page but also every post page bottom.



```

# Featured Tags

featured-tags: true  

featured-condition-size: 1     # A tag will be featured if the size of it is more than this condition value

```



The only one thing need to be paid attention to is the `featured-condition-size`: A tag will be featured if the size of it is more than this condition value.  

Internally, a condition template `{% if tag[1].size > {{site.featured-condition-size}} %}` is used to do the filter.



#### Friends



Friends is a very common feature of a blog seeing the SEO, so I add it in V1.1 release to help that.   

Friends can also live without enable sidebar, also be displayed in the bottom when sidebar unable, and be displayed in every post page bottom.



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"

    }

]

```



#### Keynote Layout



![](http://huangxuan.me/img/blog-keynote.jpg)



There is a increasing tendency to use Open Web technology to create keynotes, presentations, like Reveal.js, Impress.js, Slides, Prezi etc. I consider a modern blog should have abilities to post these HTML based presentation easily also abilities to play it directly.



Under the hood, a `iframe` is used to include webpage from outer source, so the only things left is to give a url in the **front-matter**:



```

---

layout:     keynote

iframe:     "http://huangxuan.me/js-module-7day/"

---

```



The iframe will be automatically resized to adapt different form factors also the device orientation. A padding is left to imply user that there has more content below, also to ensure that there is a area for user to scroll down in mobile device seeing most of the keynote framework prevent the browser default scroll behavior.



#### Comment



This theme support both [Disqus](http://disqus.com) and [Duoshuo](http://duoshuo.com) as the third party discussion system.



First, you need to sign up and get your own account. **Repeat, DO NOT use mine!** (I have set Trusted Domains) It is deathly simple to sign up and you will get the full power of management system. Please give it a try!



Second, from V1.5, you can easily complete your comment configuration by just adding your **short name** into `_config.yml`:



```

duoshuo_username: _your_duoshuo_short_name_

# OR

disqus_username: _your_disqus_short_name_

```



**To the old version user**, it's better that you pull the new version, otherwise you have to replace code in `post.html`, `keynote.html` and `about.html` by yourselves.



Furthermore, Duoshuo support Sharing. if you only wanna use Duoshuo comment without sharing, you can set `duoshuo_share: false`. You can use Duoshuo Sharing and Disqus Comments together also.



#### Analytics



From V1.5, we support Google Analytics and Baidu Tongji officially with a deathly simple config:



```

# Baidu Analytics

ba_track_id: 4cc1f2d8f3067386cc5cdb626a202900



# Google Analytics

ga_track_id: 'UA-49627206-1'            # Format: UA-xxxxxx-xx

ga_domain: huangxuan.me

```



Just checkout the code offered by Google/Baidu, and copy paste here, all the rest is already done for you.



(Google might ask for meta tag "google-site-verification")



#### Customization



If you wanna do more customization and change code yourself, a [Grunt](gruntjs.com) 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/` and `_layouts/`, then you can modify Jekyll [Liquid](https://github.com/Shopify/liquid/wiki) template directly to do more creative customization.**



#### Header Image



Change header images of any pages or any posts is pretty easy as mentioned above. But, thanks to [issue #6 (in Chinese)](https://github.com/Huxpro/huxpro.github.io/issues/6) asked, **how to make it looks great?**



**Well...it is actually a design issue**, not a coding stuff. It is better that you have basic design knowledge, but not is ok, let me told you how to make it well-designed:



Seeing the title text above image is **white**, the image should be **dark** to emphasize the contract. so we can easily add a **black overlay with fews of opacity**, which is depends on the brightness of the original images you used. you can process it in Photoshop, Sketch etc.



In technical views, it can be done with CSS. However, the opacity of the black overlay is really hard to assigned, **every image has different brightness so the  degree it should be adjusted is different so it is impossible to hard code it.**



#### SEO Title



Before V1.4, site setting `title` is not only used for displayed in Home Page and Navbar, but also used to generate the `` in HTML.

It's possible that you want the two things different. For me, my site-title is **“Hux Blog”** but I want the title shows in search engine is **“黄玄的博客 | Hux Blog”** which is multi-language.



So, the SEO Title is introduced to solve this problem, you can set `SEOTitle` different from `title`, and it would be only used to generate HTML `` and setting DuoShuo Sharing.



#### Page Build Warning



There are many possible reasons to cause a "Page Build Warning" email or similar error.



One of these is that github changes its build environment.



> You are attempting to use the 'pygments' highlighter, which is currently unsupported on GitHub Pages. Your site will use 'rouge' for highlighting instead. To suppress this warning, change the 'highlighter' value to 'rouge' in your '_config.yml'.



So, just edit `_config.yml`, find `highlighter: pygments`, change it to `highlighter: rouge` and the warning will be gone.



For other circumstances, check out existing issues or create a new one!



## FAQ



#### How can I customize the theme of code block?



This theme uses the default code syntax highlighter of jekyll, "rouge, which is compatible with Pygments theme so just pick any pygments theme css (e.g. from [here](http://jwarby.github.io/jekyll-pygments-themes/languages/javascript.html) and replace the content of `highlight.less`.



#### cannot load such file -- jekyll-paginate



Executing this command to install this plugin:



```

$ gem install jekyll-paginate 

```



This blog started in Jekyll 2 time when `jekyll-paginate` is standard. With Jekyll 3, it's a plugin we included in `_config.yml`.



## License



Apache License 2.0.

Copyright (c) 2015-2016 Huxpro



Hux Blog is derived from [Clean Blog Jekyll Theme (MIT License)](https://github.com/BlackrockDigital/startbootstrap-clean-blog-jekyll/)

Copyright (c) 2013-2016 Blackrock Digital LLC.