forked from laozhu/hugo-nuo
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit d8d0d70
Showing
65 changed files
with
8,012 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"presets": [ | ||
["env", { "modules": false }], | ||
"stage-2" | ||
], | ||
"plugins": ["transform-runtime"], | ||
"comments": false, | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{ | ||
"extends": "airbnb-base", | ||
"env": { | ||
"es6": true, | ||
"browser": true, | ||
}, | ||
"plugins": [ "import" ], | ||
"rules": { | ||
"no-alert": 0, | ||
"no-console": 0 | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
.sass-cache | ||
.DS_Store | ||
.eslintcache | ||
static | ||
npm-debug.log | ||
yarn-error.log | ||
node_modules | ||
!.gitignore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"extends": "stylelint-config-standard" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2017 Ritchie Zhu | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
this software and associated documentation files (the "Software"), to deal in | ||
the Software without restriction, including without limitation the rights to | ||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | ||
the Software, and to permit persons to whom the Software is furnished to do so, | ||
subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | ||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | ||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,268 @@ | ||
Hugo Nuo | ||
======== | ||
|
||
Hugo Nuo is an responsive light & clean hugo theme for blogger. This theme features several page layout, like an [about page](https://laozhu.me/about/) for your portfolio, a [links page](https://laozhu.me/links/) for your friends' blog, a works page is under development. This theme makes many third-party hugo shortcodes, including [Codepen](https://codepen.io/), [JSFiddle](https://jsfiddle.net/), [Video.js](http://videojs.com/), [网易云音乐](https://music.163.com/) and [声享](https://ppt.baomitu.com/). | ||
|
||
 | ||
|
||
Or you want → [A real site demo](https://laozhu.me) | ||
|
||
## Installation | ||
|
||
Inside the folder of your Hugo site run: | ||
|
||
```bash | ||
$ cd themes | ||
$ git clone https://github.com/laozhu/hugo-nuo | ||
``` | ||
|
||
*For more information read the official [setup guide](https://gohugo.io/overview/installing/) of Hugo.* | ||
|
||
## Getting Started | ||
|
||
After installing the hugo-nuo theme successfully it requires just a few more steps to get your site finally running. | ||
|
||
### The config file | ||
|
||
Take a look inside the [exampleSite](https://github.com/laozhu/hugo-nuo/tree/master/exampleSite) folder of this theme. You'll find a file called [config.toml](https://github.com/laozhu/hugo-nuo/blob/master/exampleSite/config.toml). To use it, copy the config.toml in the root folder of your Hugo site. Feel free to customize this theme as you like. | ||
|
||
**Site Menu** | ||
|
||
The hugo-nuo theme add `home` and `works` page to initial site menu, you can add your own menu item here. | ||
|
||
```toml | ||
[[menu.main]] | ||
name = "🏠 首页" | ||
weight = 10 | ||
identifier = "home" | ||
url = "/" | ||
|
||
[[menu.main]] | ||
name = "💻 作品" | ||
weight = 20 | ||
identifier = "works" | ||
url = "https://github.com/laozhu" | ||
``` | ||
|
||
Or you can add some other page to menu in page's front matter: | ||
|
||
```markdown | ||
--- | ||
title: "🔗 友链" | ||
date: 2017-08-02 | ||
layout: "links" | ||
menu: "main" | ||
weight: 30 | ||
--- | ||
``` | ||
|
||
**Social Networks** | ||
|
||
The following social network icons are available: | ||
|
||
```toml | ||
[params] | ||
email = "[email protected]" | ||
github = "github_username" | ||
twitter = "twitter_username" | ||
linkedin = "linkedin_username" | ||
weibo = "weibo_username" | ||
wechat= "/img/qrcode.jpg" # Replace with your wechat qrcode image | ||
facebook = "facebook_username" | ||
google = "googlplus_id_number" | ||
instagram = "instagram_username" | ||
youtube = "youtube_username" | ||
vimeo = "vimeo_username" | ||
medium = "medium_username" | ||
quora = "quora_username" | ||
pinterest = "pinterest_username" | ||
dribbble = "dribbble_username" | ||
behance = "behance_username" | ||
jsfiddle = "jsfiddle_username" | ||
codepen = "codepen_username" | ||
zhihu = "zhihu_username" | ||
douban = "douban_username" | ||
bilibili = "bilibili_id_number" | ||
``` | ||
|
||
You can choose someone to display, the recommend number is 7 icons. | ||
|
||
**SEO** | ||
|
||
The hugo-nuo theme support [Google](https://www.google.com/webmasters/), [Bing](https://www.bing.com/toolbox/webmaster/), [Baidu](https://zhanzhang.baidu.com/), [Sogou](http://zhanzhang.sogou.com/), [360](http://zhanzhang.so.com/) webmaster's meta verification tool, you can activate as required. The `seotitle` and `description` will show in search results and browser title. | ||
|
||
```toml | ||
[params] | ||
seotitle = "Hugo Blog Title (SEO Version)" | ||
description = "这里是 @米老朱 的个人博客,记录他在互联网新世界探索的点点滴滴。" | ||
|
||
# Google Webmaster | ||
# https://www.google.com/webmasters/ | ||
googleSiteVerification = "google_site_verification_code" | ||
|
||
# Bing Webmaster | ||
# https://www.bing.com/toolbox/webmaster/ | ||
msValidate = "bing_site_verification_code" | ||
|
||
# Baidu Webmaster (China Only) | ||
# https://zhanzhang.baidu.com/ | ||
# baiduSiteVerification = "baidu_site_verification_code" | ||
|
||
# Sogou Webmaster (China Only) | ||
# http://zhanzhang.sogou.com/ | ||
# sogouSiteVerification = "sogou_site_verification_code" | ||
|
||
# 360 Webmaster (China Only) | ||
# http://zhanzhang.so.com/ | ||
# soSiteVerification = "360_site_verification_code" | ||
``` | ||
|
||
**Website Analytics** | ||
|
||
The hugo-nuo theme support [Google Analytics](https://www.google.com/analytics/) and [Baidu Tongji](https://tongji.baidu.com/), In China you can choose both Baidu Tongji and Google Analytics. | ||
|
||
```toml | ||
# Google Analytics UA number | ||
googleAnalytics = "UA-XXXXXXXX-X" | ||
|
||
[params] | ||
# Baidu Tongji (China Only) | ||
# https://tongji.baidu.com/ | ||
baiduTongji = "baidu_tongji_code" | ||
``` | ||
|
||
**Social Comments** | ||
|
||
The hugo-nuo theme support [Disqus](https://disqus.com/) and [Chang Yan](https://changyan.kuaizhan.com/) social comment system, In China you can choose Chang Yan because Disqus is blocked by GFW. | ||
|
||
```toml | ||
# Disqus Username | ||
disqusShortname = "melaozhu" | ||
|
||
[params] | ||
# Changyan Comments (China Only) | ||
changyan = false | ||
changyanId = "your_changyan_id" | ||
changyanConf = "your_changyan_conf" | ||
``` | ||
|
||
If you want to use Disqus, you should disable `changyan` to `false`. | ||
|
||
### The works page | ||
|
||
The works page layout is under development, you can use github homepage for replacement temporarily. | ||
|
||
### The links page | ||
|
||
Inside the folder of your Hugo site run: | ||
|
||
```bash | ||
$ hugo new links.md | ||
$ mkdir data && touch data/links.yml | ||
$ mkdir -p content/media/links | ||
$ vim content/links.md | ||
``` | ||
|
||
Change the content of `links.md`, set page layout to `links`, If you want to add about page to menu, set menu to `main` and `weight` to 30. | ||
|
||
```markdown | ||
--- | ||
title: "🔗 友链" | ||
date: 2017-08-02 | ||
layout: "links" | ||
menu: "main" | ||
weight: 30 | ||
--- | ||
``` | ||
|
||
The links page read data from `data/link.yml` file, now you can add friend's links there. The format looks like: | ||
|
||
```yaml | ||
01_link: | ||
title: chekun's blog | ||
link: https://chekun.me | ||
avatar: /media/links/chekun.jpg | ||
description: 车老板的博客 | ||
|
||
02_link: | ||
title: 十里波澜 | ||
link: http://boof.wang | ||
avatar: /media/links/wangbo.jpg | ||
description: 王老板的博客 | ||
``` | ||
The links page need friend's avatar, finally you should add friend's avatar to `content/media/links` directory and link to avatar in the `links.yml` file. | ||
|
||
### The about page | ||
|
||
Inside the folder of your Hugo site run: | ||
|
||
```bash | ||
$ hugo new about.md | ||
$ vim content/about.md | ||
``` | ||
|
||
Change the content of `about.md`, set page layout to `about`, If you want to add about page to menu, set menu to `main` and `weight` to 40. | ||
|
||
```markdown | ||
--- | ||
title: "🤓 关于" | ||
date: 2017-08-02 | ||
layout: "about" | ||
menu: "main" | ||
weight: 40 | ||
comments: false | ||
--- | ||
Write something about you here. | ||
``` | ||
|
||
Write your portfolio as a post here, if you want comments in about page, you should turn comments to `true`. | ||
|
||
## Build | ||
|
||
Inside the folder of your Hugo site run: | ||
|
||
```bash | ||
# Install dependencese | ||
$ cd themes/hugo-nuo | ||
$ npm install | ||
# Scripts dev | ||
$ npm run dev | ||
$ npm run build | ||
# Styles dev | ||
$ npm run sass | ||
# Copy fonts to static | ||
$ npm run fonts | ||
# Copy images to static | ||
$ npm run images | ||
# Scripts lint | ||
$ npm run eslint | ||
# Styles lint | ||
$ npm run stylelint | ||
# Minify images | ||
$ npm run imagemin | ||
``` | ||
|
||
If you want to build hugo-nuo theme, you should have `node` and `npm` evironment installed. Besides, you should have dependencies below installed. | ||
|
||
- [ImageOptim](https://imageoptim.com/) - Makes images load faster | ||
- [SASS](http://sass-lang.com/install) - Ruby version SASS compiler | ||
- [Pygments](http://pygments.org/) - Python syntax highlighter | ||
|
||
## Nearly finished | ||
|
||
In order to see your site in action, run Hugo's built-in local server. | ||
|
||
```bash | ||
$ hugo server -w | ||
``` | ||
|
||
Now enter [localhost:1313](http://localhost:1313) in the address bar of your browser. | ||
|
||
## Credits | ||
|
||
- [Video.js](http://videojs.com/) | ||
- [MathJax](https://www.mathjax.org/) | ||
- [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll) | ||
- [BootCDN](http://www.bootcdn.cn/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: "{{ replace .TranslationBaseName "-" " " | title }}" | ||
author: "Author Name" | ||
cover: "/img/cover.jpg" | ||
tags: [] | ||
date: {{ .Date }} | ||
draft: true | ||
--- | ||
|
||
Cut out summery from your post content here. | ||
|
||
<!--more--> | ||
|
||
The remaining content of your post. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.