README.md in jekyll-theme-mdui-0.3.0 vs README.md in jekyll-theme-mdui-0.4.0
- old
+ new
@@ -2,11 +2,11 @@
A Jekyll theme based on mdui
[demo](https://blog.kejun.space)
-[]()
+[]()
[](https://jekyllrb.com/)
[](https://rubygems.org/gems/jekyll-theme-mdui/)
[](https://codeclimate.com/github/KeJunMao/jekyll-theme-mdui/)
[](https://travis-ci.org/KeJunMao/jekyll-theme-mdui)
@@ -14,10 +14,12 @@
[](https://blog.kejun.space)
## Installation
+**Now,we have `build` branch ,you can clone this branch to install.**
+
We have two ways to install themes.
But,**We recommend you use the second ways.**
### First ways
@@ -106,35 +108,52 @@
- name: bilibili # name
url: # url , if it is empty, it is not enabled
```
Supported:bilibili,facebook,github,gplus,instagram,linkedin,telegram,tumblr,twitter,weibo,zhihu
-* site.yml
+* **site.yml**
```yml
head:
- favicon: "https://ooo.0o0.ooo/2017/05/27/59294212bc16e.png" # 网站的favicon
- high_res_favicon: "https://ooo.0o0.ooo/2017/06/08/5939484dc618e.png" # 高清favicon
- apple_touch_icon: "https://ooo.0o0.ooo/2017/06/08/5939484dc618e.png" # ios主屏按钮图标
- keywords: "blog jekyll mdui theme" # 页面关键字
+ favicon: "https://ooo.0o0.ooo/2017/05/27/59294212bc16e.png" # the favicon
+ high_res_favicon: "https://ooo.0o0.ooo/2017/06/08/5939484dc618e.png" # the favicon using high quality format
+ apple_touch_icon: "https://ooo.0o0.ooo/2017/06/08/5939484dc618e.png" # the iOS Home button icon
+ keywords: "blog jekyll mdui theme" # the site keywords
+
uiux:
- android_chrome_color: "#607D8B" # 安卓 Chrome 浏览器的地址栏颜色。
- nprogress_color: "#29d" # 页面加载时顶部加载进度条的颜色。
- nprogress_buffer: 200 # 页面加载时顶部加载进度条的缓冲时间。
+ android_chrome_color: "#eeeeee" # the color of the Chrome address bar
+ nprogress_color: "#29d" # the color of the top loading progress bar
+ nprogress_buffer: 200 # the top loading progress bar buffers
+
background:
- purecolor: "#eeeeee" # 背景颜色
+ purecolor: "#eeeeee" # the background color
+
img:
- avatar: "https://ooo.0o0.ooo/2017/05/26/5928368d409dd.png" # 你的头像设置。
-card: # 首页卡片
- card_shadow: 1 # 卡片阴影 0-24,0为不显示
- card_hoverable: false # 悬浮时加深阴影
+ avatar: "https://ooo.0o0.ooo/2017/05/26/5928368d409dd.png" # your avatar
+
+card:
+ card_shadow: 1 # card shadow (0-24), 0 is not displayed
+ card_hoverable: false # When the hover to deepen the shadow
+
+sns_share: # SNS Share Switch
+ twitter: true
+ facebook: false
+ googleplus: false
+ weibo: true
+ linkedin: false
+ qq: true
+ telegram: true
+
disqus:
- disqus_shortname: "kejun" # Your disqus
- disqus_proxy: false
- disqus_proxy_url: "" # disqus proxy(Do not use)
+ disqus_shortname: "" # Your disqus
+ disqus_button: true # disqus load button
+ disqus_proxy: false # # disqus proxy(Do not use)
+ disqus_proxy_url: "" # (Do not use)
disqus_api_key: "" # (Do not use)
-google_analytics: "" # (Do not use)
-lang: "zh-CN" # lang
+
+google_analytics: "" # google analytics code
+
+lang: "en-US" # lang
```
### manifest.json
```json
{
@@ -184,37 +203,40 @@
## Note
### file
If you use the first ways to install, you need to download the following files to your jekyll website root directory Or create a new file,And replace it with your own information:
-* mainifest.json
-* sw.js
-* search.json
-* tags.json
-* _data/friends.yml
-* _data/menus.yml
-* _data/sns.yml
-* assets/images/touch/*
-* pages/*
+|files|Required or Optional|Description|
+|--- |--- |--- |
+|mainifest.json|Optional |Is the only file that every WebExtension must contain.See [here](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json).|
+|sw.js|Optional |Service Workers.See [here](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers).|
+|search.json|Optional|If you use the search page, it is required.|
+|tags.json|Optional|If you use the tags page, it is required.|
+|_data/friends.yml|Optional|If you use the friends page, it is required.|
+|_data/sns.yml|Optional|It is footer sns,if you want userd, it is required.|
+|_data/site.yml|Required|It is theme config.|
+|_data/lang.yml|Required|It is language config.|
+|_data/menus.yml|Required|It is site menus config.|
How to use? See Usage.
### service workers
If you use the first ways to install, You will not be able to use service workers!!!!
Why? See `sw.js` content.
+
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/KeJunMao/jekyll-theme-mdui. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Development
To set up your environment to develop this theme, run `bundle install`.
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
-When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
+When your theme is released, only the files in `_layouts`, `_includes`, and `assets` tracked with Git will be released.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).