https://github.com/li-plus/li-plus.github.io
My personal blog
https://github.com/li-plus/li-plus.github.io
Last synced: 20 days ago
JSON representation
My personal blog
- Host: GitHub
- URL: https://github.com/li-plus/li-plus.github.io
- Owner: li-plus
- License: apache-2.0
- Created: 2020-12-25T13:53:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-12-25T17:06:16.000Z (over 4 years ago)
- Last Synced: 2025-02-15T23:41:57.554Z (3 months ago)
- Language: HTML
- Homepage: https://li-plus.github.io
- Size: 41.6 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[Hux Blog](https://huangxuan.me)
================================
> I never expected this becomes popular.
[User Manual 👉](_doc/Manual.md)
--------------------------------------------------
### Getting Started
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.
2. Installed dependencies in the `Gemfile`:
```sh
$ bundle install
```
3. Serve the website (`localhost:4000` by default):
```sh
$ bundle exec jekyll serve # alternatively, npm start
```
### Development (Build From Source)
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.
Yes, they were inherited and are extremely old-fashioned. There is no modularization and transpilation, etc.
Critical Jekyll-related code are located in `_include/` and `_layouts/`. Most of them are [Liquid](https://github.com/Shopify/liquid/wiki) templates.
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`.
### Interesting to know more? Checkout the [full user manual](_doc/Manual.md)!
Other Resources
---------------
Ports
- [**Hexo**](https://github.com/Kaijun/hexo-theme-huxblog) by @kaijun
- [**React-SSR**](https://github.com/LucasIcarus/huxpro.github.io/tree/ssr) by @LucasIcarus
[Starter/Boilerplate](https://github.com/huxpro/huxblog-boilerplate)
- Out of date. Helps wanted for updating it on par with the main repo
Translation
- [🇨🇳 (somewhat outdated)](https://github.com/Huxpro/huxpro.github.io/blob/master/_doc/README.zh.md)
License
-------
Apache License 2.0.
Copyright (c) 2015-present 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.