<commit_before>## hexo-theme-skapp

### 项目简介

笔者出于强迫症，写了 skapp 这个主题，为得就是看起来顺眼点。。。哭。。。

附上预览地址： [demo][demo]

#### 主题效果
    
![screenshot][screenshot]

#### 语言支持

主题默认支持 `zh-cn`、`en` 两种语言，有需要其它语言的可以自行扩展，将相应语言写成 yml 文件放置于主题下的 `languages` 文件下。

### 使用方式

基本的 hexo 博客搭建请参照 [hexo官网][hexo]，配置完 hexo 项目后再进行下面的操作。

> 以下操作均默认当前路径为 hexo 博客项目目录，请自行进入项目中。

使用 git 将主题 clone 至你的 hexo 博客项目下的 themes 文件夹下

``` shell
cd themes && git clone https://github.com/Mrminfive/hexo-theme-skapp.git
```

clone 完后将根目录下的 `_config.yml` 文件中的 `theme` 字段设置为 `hexo-theme-skapp`，同时安装对应 node 依赖：

``` shell
npm install --save-dev hexo-autoprefixer hexo-filter-cleanup hexo-generator-feed hexo-generator-sitemap hexo-renderer-sass hexo-renderer-swig mamboer/lunr.js moment node-sass object-assign
```

*注意*：如果安装失败可尝试用 cnpm 进行安装。

安装完依赖后将以下配置写入根目录下的 `_config.yml` 文件中

``` yml
# Lunr
lunr:
  field: all
  fulltext: false
  path: assets/lunr/

# filter_cleanup
hfc_useref:
  enable: true
  concat: true

hfc_html:
  enable: true
  exclude:

hfc_css:
  enable: true
  exclude: 
    - '*.min.css'

hfc_js:
  enable: true
  mangle: true
  exclude: 
    - '*.min.js'

hfc_img:
  enable: false
  interlaced: false
  multipass: false
  optimizationLevel: 2
  pngquant: false
  progressive: false

hfc_favicons:
  enable: false
  src: img/blog-logo.png
  target: img/
  icons:
    android: true
    appleIcon: true
    appleStartup: false
    coast: false
    favicons: true
    firefox: false
    opengraph: false
    windows: true
    yandex: false
```

ok，走到这一步主题编译需要的环境配置完了，可以使用 `hexo s --debug` 进行本地预览了。

### 主题配置

#### 设置语言

编辑根 `_config.yml` 文件，将 `language` 设置为你想要的语言：

``` yml
language: zh-cn
```

目前主题支持的语言如下：

| 语言     |  代码  |
| ------- | ----- |
| English | en |
| 简体中文 | zh-cn |

#### 设置菜单

编辑根 `_config.yml` 文件，将 `menu` 设置为如下：

``` yml
menu:
  home: / 
  archive: /archives
  about: /about
```

主题默认的菜单项有：

| 键值 | 设定值 | 显示文本（简体中文）|
| --- | ----- | ---------------- |
| home | home: / | 首页 |
| archive | archive: /archives | 归档 |
| about | about: /about | 关于 |
| search | search: /search | 搜索页 | 

其中 `about`、`search` 与主题内置的 `404` 页面一样需要手动创建，创建方式如下：

创建 about 页面：

``` shell
hexo new page about
```

然后编辑 source 文件夹下的 about 文件夹中的 index.md 文件：

``` md
---
title: 关于
date: 2017-07-29 00:50:51
type: about
layout: about
---

...(以下内容将渲染在关于页面中)
```

创建 search 页面：

``` shell
hexo new page search
```

然后编辑 source 文件夹下的 about 文件夹中的 index.md 文件：

``` md
---
title: 关于
date: 2017-07-29 00:50:51
type: search
layout: search
---

404 页面则直接在 source 目录下创建 404.md 文件，文件内容如下：

``` md
---
title: 404 Page Not Found
date: 2017-08-04 23:36:59
type: error
layout: error
---
```

#### 博客信息配置

以下配置均在根 `_config.yml` 中：<commit_msg>docs(README): update README.md<commit_after>## hexo-theme-skapp

### 项目简介

笔者出于强迫症，写了 skapp 这个主题，为得就是看起来顺眼点。。。哭。。。

附上预览地址： [demo][demo]

#### 主题效果
    
![screenshot][screenshot]

#### 语言支持

主题默认支持 `zh-cn`、`en` 两种语言，有需要其它语言的可以自行扩展，将相应语言写成 yml 文件放置于主题下的 `languages` 文件下。

### 使用方式

基本的 hexo 博客搭建请参照 [hexo官网][hexo]，配置完 hexo 项目后再进行下面的操作。

> 以下操作均默认当前路径为 hexo 博客项目目录，请自行进入项目中。

使用 git 将主题 clone 至你的 hexo 博客项目下的 themes 文件夹下

``` shell
cd themes && git clone https://github.com/Mrminfive/hexo-theme-skapp.git
```

clone 完后将根目录下的 `_config.yml` 文件中的 `theme` 字段设置为 `hexo-theme-skapp`，同时安装对应 node 依赖：

``` shell
npm install --save-dev hexo-autoprefixer hexo-filter-cleanup hexo-generator-feed hexo-generator-sitemap hexo-renderer-sass hexo-renderer-swig mamboer/lunr.js moment node-sass object-assign
```

*注意*：如果安装失败可尝试用 cnpm 进行安装。

安装完依赖后将以下配置写入根目录下的 `_config.yml` 文件中

``` yml
# Lunr
lunr:
  field: all
  fulltext: false
  path: assets/lunr/

# filter_cleanup
hfc_useref:
  enable: true
  concat: true

hfc_html:
  enable: true
  exclude:

hfc_css:
  enable: true
  exclude: 
    - '*.min.css'

hfc_js:
  enable: true
  mangle: true
  exclude: 
    - '*.min.js'

hfc_img:
  enable: false
  interlaced: false
  multipass: false
  optimizationLevel: 2
  pngquant: false
  progressive: false

hfc_favicons:
  enable: false
  src: img/blog-logo.png
  target: img/
  icons:
    android: true
    appleIcon: true
    appleStartup: false
    coast: false
    favicons: true
    firefox: false
    opengraph: false
    windows: true
    yandex: false
```

ok，走到这一步主题编译需要的环境配置完了，可以使用 `hexo s --debug` 进行本地预览了。

### 主题配置

#### 设置语言

编辑根 `_config.yml` 文件，将 `language` 设置为你想要的语言：

``` yml
language: zh-cn
```

目前主题支持的语言如下：

| 语言     |  代码  |
| ------- | ----- |
| English | en |
| 简体中文 | zh-cn |

#### 设置菜单

编辑根 `_config.yml` 文件，将 `menu` 设置为如下：

``` yml
menu:
  home: / 
  archive: /archives
  about: /about
```

主题默认的菜单项有：

| 键值 | 设定值 | 显示文本（简体中文）|
| --- | ----- | ---------------- |
| home | home: / | 首页 |
| archive | archive: /archives | 归档 |
| about | about: /about | 关于 |
| search | search: /search | 搜索页 | 

其中 `about`、`search` 与主题内置的 `404` 页面一样需要手动创建，创建方式如下：

创建 about 页面：

``` shell
hexo new page about
```

然后编辑 source 文件夹下的 about 文件夹中的 index.md 文件：

``` md
---
title: 关于
date: 2017-07-29 00:50:51
type: about
layout: about
---

...(以下内容将渲染在关于页面中)
```

创建 search 页面：

``` shell
hexo new page search
```

然后编辑 source 文件夹下的 about 文件夹中的 index.md 文件：

``` md
---
title: 关于
date: 2017-07-29 00:50:51
type: search
layout: search
---
```

404 页面则直接在 source 目录下创建 404.md 文件，文件内容如下：

``` md
---
title: 404 Page Not Found
date: 2017-08-04 23:36:59
type: error
layout: error
---
```

#### 博客信息配置

以下配置均在根 `_config.yml` 中：
{'fraction_non_alphanumeric': 0.15740568667533916, 'fraction_numerical': 0.020442296970823268, 'mean_word_length': 3.2079749804534794, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6010208', 'n_tokens_mistral': 2969, 'n_tokens_neox': 3049, 'n_words': 551}