|
| 1 | +[Hux Blog](https://huangxuan.me) |
| 2 | +================================ |
| 3 | + |
| 4 | +> I never expected this becomes popular. |
| 5 | +
|
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +[User Manual 👉](_doc/Manual.md) |
| 10 | +-------------------------------------------------- |
| 11 | + |
| 12 | +### Getting Started |
| 13 | + |
| 14 | +1. You will need [Ruby](https://www.ruby-lang.org/en/) and [Bundler](https://bundler.io/) to use [Jekyll](https://jekyllrb.com/). Following [Using Jekyll with Bundler](https://jekyllrb.com/tutorials/using-jekyll-with-bundler/) to fullfill the enviromental requirement. |
| 15 | + |
| 16 | +2. Installed dependencies in the `Gemfile`: |
| 17 | + |
| 18 | +```sh |
| 19 | +$ bundle install |
| 20 | +``` |
| 21 | + |
| 22 | +3. Serve the website (`localhost:4000` by default): |
| 23 | + |
| 24 | +```sh |
| 25 | +$ bundle exec jekyll serve # alternatively, npm start |
| 26 | +``` |
| 27 | + |
| 28 | +### Development (Build From Source) |
| 29 | + |
| 30 | +To modify the theme, you will need [Grunt](https://gruntjs.com/). There are numbers of tasks you can find in the `Gruntfile.js`, includes minifing JavaScript, compiling `.less` to `.css`, adding banners to keep the Apache 2.0 license intact, watching for changes, etc. |
| 31 | + |
| 32 | +Yes, they were inherited and are extremely old-fashioned. There is no modularization and transpilation, etc. |
| 33 | + |
| 34 | +Critical Jekyll-related code are located in `_include/` and `_layouts/`. Most of them are [Liquid](https://github.com/Shopify/liquid/wiki) templates. |
| 35 | + |
| 36 | +This theme uses the default code syntax highlighter of jekyll, [Rouge](http://rouge.jneen.net/), 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`. |
| 37 | + |
| 38 | + |
| 39 | +### Interesting to know more? Checkout the [full user manual](_doc/Manual.md)! |
| 40 | + |
| 41 | + |
| 42 | +Other Resources |
| 43 | +--------------- |
| 44 | + |
| 45 | +Ports |
| 46 | +- [**Hexo**](https://github.com/Kaijun/hexo-theme-huxblog) by @kaijun |
| 47 | +- [**React-SSR**](https://github.com/LucasIcarus/huxpro.github.io/tree/ssr) by @LucasIcarus |
| 48 | + |
| 49 | +[Starter/Boilerplate](https://github.com/huxpro/huxblog-boilerplate) |
| 50 | +- Out of date. Helps wanted for updating it on par with the main repo |
| 51 | + |
| 52 | +Translation |
| 53 | +- [🇨🇳 (somewhat outdated)](https://github.com/Huxpro/huxpro.github.io/blob/master/_doc/README.zh.md) |
| 54 | + |
| 55 | + |
| 56 | +License |
| 57 | +------- |
| 58 | + |
| 59 | +Apache License 2.0. |
| 60 | +Copyright (c) 2015-present Huxpro |
| 61 | + |
| 62 | +Hux Blog is derived from [Clean Blog Jekyll Theme (MIT License)](https://github.com/BlackrockDigital/startbootstrap-clean-blog-jekyll/) |
| 63 | +Copyright (c) 2013-2016 Blackrock Digital LLC. |
| 64 | +# litrane.github.io |
| 65 | +"# litrane.github.io" |
| 66 | +"# litrane.github.io" |
0 commit comments