Kratos-Rebirth食用说明

是时候写一个文档了！（被打死
如果有什么遗漏的地方欢迎随时向我提出！可以用留言的方式（但有时候邮箱会收不到邮件，比较怨念），或者去Github提一个Issue~
文档会尽可能在两边都保持更新，所以只要我没忘记的话应该是没什么大问题哒（光速逃跑）

安装提示

由于本模板使用了和默认模板landscape一样的ejs引擎，因此当您完成Hexo站点的安装后，您应该能够直接运行本主题。

主题配置

配置文件地址：./kratos-rebirth/_config.yml

- Global 全局配置

• site_analytics : 站点统计代码，这一行代码会被插入到后页脚。

• hoster : 网站托管服务提供者，这个是出于感恩性的可选添加内容，这一个链接会被插入到后页脚。

• site_logo : 网站的LOGO图片文件，请注意与后面核心JS的设置保持一致。

• snow : (true/false)站点下雪特效开关，控制是否在载入下雪相关的代码。

• click_animate_js : (filename/false) 点击事件使用的动画 js 文件，默认为 candy 即主题自带的 candy.js 文件，您可以设置成 false 表示禁用，或是引入其他您喜欢的动画 js 文件。

• enable_dark : (true/false)站点是否启用暗色模式适配。请注意，即使启用了暗色模式，在亮色的环境下主题仍然会渲染为亮色模式；同时用户可以手动选择使用的颜色（右下角菜单栏按钮处）。

• highlight_theme : 代码高亮主题，五选一（light | night | night-eighties | night-blue | night-bright），控制代码高亮时候使用的配色。会根据用户的选择自动加载对应的高亮主题文件。

• cdn (jsdelivr/unpkg/false)为静态资源开启CDN加速（使用jsDelivr或是unpkg，如果开启则默认使用jsdelivr，有其他什么好建议可以随时提出issue）。请注意，如果您修改了任何静态资源，那么请保持此项为false（同时也是默认状态）

• check_update (true/false)版本更新检查，无需检查的话就记得关闭哦。

- Custom Styles 自定义样式

这部分配置的内容可以覆盖 CSS 文件中指定的部分。

• images 图片
  • banner 站点横幅
  • background 站点背景

- Index 首页配置相关

• post_type (true/false)站点首页是否使用文章主题的显示模式（即一开始可见一部分，点击阅读更多可以加载全文，Hexo许多主题都默认的显示模式（而不是默认的这种卡片式的陈列方式）

• read_count (true/false)在首页显示每篇文章的阅读量统计（目前仅支持 valine/waline 评论系统的内置统计功能）

• comment_count (true/false)在首页显示每篇文章的评论量统计（目前仅支持 waline 评论系统的内置统计功能）

- Top Menu 顶部导航栏相关

• (>2.0.3) 可以尝试更优雅的新配置方案，每一项的配置含义解释为：

1
2
3
4
5
6
7

- label: 这个菜单的标签文字
  icon: 这个菜单前的图标（在 FontAwesome 4.7.0 图标库中选择，可以不设置）
  url: 这个菜单指向的链接（站内或是站外均可）
  submenu: 这个菜单是否为一个二级菜单，有了这个选项就会忽略上面的 url
    - label: 二级菜单项的标签文字 
      icon: 二级菜单前的图标（在 FontAwesome 4.7.0 图标库中选择，可以不设置）
      url: 二级菜单项指向的链接

具体可以参见 .demo/_config.kratos-rebirth.yml 中示例的配置哦。

1
2
3
4
5
6
7
8
9
10
11
12
13

menu:
  二级菜单:
    submenu: true
    菜单项1: 地址1
    菜单项2: 地址2
    ...

label:
  二级菜单:
    submenu: 菜单显示内容
    菜单项1: 菜单项1显示内容
    菜单项2: 菜单项2显示内容
    ...

- Footer 页脚显示相关

• group_link : 控制是否在页面右下角显示群聊的加入按钮。如果显示的话，这里可以指定加群的链接。无需显示的话请留空（而不是删除这个设置项），相关的代码会自行处理结构生成关系。

• contact （即将废弃）: 联系方式相关，控制是否在页脚(./kratos-rebirth/layout/_partial/footer.ejs)显示各种联系方式的按钮
  如果要启用的话，请输入相关联系方式的代码，直接输入用户名即可（fediverse的实例需要输入实例地址，邮箱请使用mail@example.com这样的格式）；无需显示的内容请留空。

• footerLinks : 控制在页脚显示各种联系方式的按钮，为数组，其中每个元素应为以下的样式：

  1 2 3 4

  - icon: # 和 html 二选一，该选项表示使用来自 FontAwesome 4.7.0 图标库，内容为图标库中的唯一标识 （会被渲染为 <i class="fa fa-icon %>"></i> html: # 和 icon 二选一，该选项表示插入自定义的 HTML 作为标识，例如您可在此放置一串 svg link: # 按钮导向的目标链接 currentPage: # 可选，默认为否，启用该选项表示在当前页内打开目标链接

  具体的样例可以参照项目的 .demo/_config.kratos_rebirth.yml 配置样例。

• timenotice : 本站运行时间前的提示文本。

• icp : ICP备案号，便于生成快捷链接，如萌ICP备22010101号

• psr : 公安备案号，便于生成快捷链接，如371402000001

- Post Page 文章页面相关

• show_cc : (true/false)控制文章页面(./kratos-rebirth/layout/post.ejs)是否显示CreativeCommon知识共享协议相关的提示内容w

• donate : (true/false)控制文章页面是否显示捐助的二维码按钮，二维码链接可以在站点的 JavaScript 相关的配置 里进行修改（详见下文）

• share : (true/false)控制文章页面是否显示分享链接的按钮

• comments :

  • provider: (disqus/disqusjs/valine/twikoo/waline/gitalk/gitment/false)会从layout/_comments文件夹中加载指定的评论系统，您也可以自定义其他的解决方案。如果不想开启评论的话，那就还是设置为false吧~
  • enableBGImage: (true/false)控制是否在评论系统中显示背景图片

• wordCount :

  • enable: (true/false)控制文章页面是否启用字数统计显示，默认为 true
  • threshold: 控制文章页面字数统计功能进入估算模式的字符数分割点，默认为 1500

- Disqus 评论相关

• shortname : 站点短代号，需与 Disqus Admin - Settings - General - Shortname 的保持一致

- DisqusJS 评论相关

这里使用了DisqusJS这个项目，具体的参数配置相关的可以参考原始文档，这里提供的说明仅供参考w

• shortname : 站点短代号，需与 Disqus Admin - Settings - General - Shortname 的保持一致

• sitename : 站点名，建议与 Disqus Admin - Settings - General - Website Name 的保持一致

• api : API服务器地址，官方有提供一个反向代理地址https://disqus.skk.moe/disqus/，也可以使用其他的API代理服务，或是自建相关的代理，如本站使用自建的代理(https://disqus.candinya.com/api/)

• apikey : DisqusJS发起请求时使用的公钥，本主题目前只考虑了一个的情况，如果有多请求需求的话可以考虑直接修改./kratos-rebirth/layout/_comments/disqusjs.ejs的代码

• admin : 站点评论区管理员的Disqus用户名，可以在 Disqus - Settings - Account - Username 获取或进行修改

• adminlabel : 站点管理员的提示标签，可以在 Disqus Admin - Settings - Community - Moderator Badge Text 获取或进行修改

- Valine 评论相关

这里使用了Valine这个项目，具体的参数配置相关的可以参考原始文档，这里提供的说明仅供参考；如果您有自定义功能的需要，您可以考虑手动修改layout/_comments/valine.ejs文件中相关的配置内容。

• app_id : 您LeanCloud的APP ID

• app_key : 您LeanCloud的APP Key

• visitor : (true/false)是否开启Valine的阅读统计功能

• enableQQ : (true/false)是否开启昵称框自动获取QQ昵称和QQ头像

- twikoo评论相关

• env_id : 您twikoo的Env ID

- Waline 评论相关

这里使用了Waline这个项目，具体的参数配置相关的可以参考Waline文档的前端配置段，自行调整相关前后端的配置。在该配置段下的内容都会被自动引入至评论模块中。el 和 path 会在页面自动生成，不必加入。

- Gitalk 评论相关

这里使用了Gitalk这个项目，具体的参数配置相关的可以参考Gitalk 文档，自行调整相关前后端的配置。在该配置段下的内容都会被自动引入至评论模块中。id 会在页面自动生成，不必加入。

- APlayer 音乐播放器相关（页面左下角）

• enabled : (true/false)用音乐来点缀全新的体验吧！这里可以选择是否开启aplayer播放器哦~

• playlist : APlayer播放使用的歌单地址，可以使用公开的API服务，或是搭建自己使用的后端。
  我提供了一个后端API的样例，目前本站点使用的就是这个，可以去Github获取。不过这个项目已经过时，我们推荐使用下一种加载方式，即使用MetingJS（默认使用api.i-meto.com/meting/api解析）的方式来加载。

• meting : 使用MetingJS时请保留该选项

  • server : 使用的音乐服务来源：netease, tencent, kugou, xiami, baidu
  • type : 加载的播放列表类型：song, playlist, album, search, artist
  • id : 请求的ID，如曲目ID、播放列表ID、专辑ID、搜索关键词等

• order : (list/random)音乐播放的顺序，我个人比较喜欢的是random模式，这样就能避免每次访问博客时，都是从第一首音乐开始播放的尴尬清情况。

- Widgets 侧边栏与挂件

• sidebar : (left/right/none)是否启用侧边栏与小工具，若设置为left则会显示在页面左侧，若设置为right则会显示在页面右侧。

• widgets : 启用的小部件，默认全部启用，不喜欢的就删掉吧

  请注意splitter是分隔符，用于分割活动区域和固定区域（例如默认配置下文章页向下滚动时，About区块会顺势上浮，toc区块会固定在最顶，您可以手动调整各小挂件的位置，删除splitter表示禁用该功能（即所有小挂件均固定显示）

• avatarUri : 头像的图片地址链接

• mobile_toc : 移动端文章目录显示相关配置

  • hide : (true/false)是否隐藏移动端目录
  • hide_id : (true/false)移动端目录前是否自动补充的标号

- FancyBox 图片放大显示

• fancybox : (true/false)启用图片放大显示工具，点击文章内的图片可以进行全屏放大操作

- Search 搜索

• enable : (true/false)是否启用站点搜索功能

• path : 搜索数据库的文件名，一般保持默认search.json即可

• field : 搜索的区域，可以是页面，或是文章，或是所有内容。默认情况下是仅搜索文章内容。

• content : (true/false)搜索内容是否包含文章或是页面的详细内容

- JavaScript 相关的配置

• main : 主JavaScript配置
  • cover : 无图片文章使用的随机封面图片相关设置
    • randomAmount : 表示图片的编号为 1 ~ 您设定的值，默认是 20
    • baseUrl : 图片的基础链接，例如使用本地图片则为 /images/thumb/ （请注意您的站点路径）
    • coverFileNameTemplate : 图片的文件名格式模板，默认为 thumb_{no}.webp ，使用时代码会将 {no} 替换成随机的数字编号
  • createTime 站点建立的时间，请改成您站点建立的时间。该项与页脚的运行时间有直接关联，建议按照样例格式进行书写，以免出现莫名其妙的报错。
  • donateBtn 捐助按钮上显示的文字，建议不要太长以免溢出，如果不显示捐助按钮的话就不用去管它啦~
  • kr.scanNotice 二维码小窗口上的小标题，如果不显示捐助按钮的话也不用去管它啦~
  • qr_alipay 支付宝二维码的文件地址
  • qr_wechat 微信支付二维码的文件地址
  • siteLeaveEvent (true/false)是否启用站点失焦事件（只是为了卖萌，有可能会影响到历史记录，请谨慎开启）
  • leaveTitle 离开时候站点标题的追加内容
  • returnTitle 返回时候站点标题的追加内容
  • expire_day 文章过期提示：距离最后更新时间多少天时，打开文章页面会给出提示信息。对于无标题的 Status 类默认不启用，但您可以在 Front Matter 区域内加上 expire: true 来手动开启。
  • topNavScrollToggle (true/false)顶部导航栏在页面向下滚动时隐藏

- Site verify related 站点所有权验证相关

• site_verify :
  • google : Google Search，只填写中间那一串随机码即可
  • baidu : 百毒搜索，同样只需填写中间的一串随机码
  • bing : 必应搜索，同样只需填写中间的一串随机码

- Friends page related 友链页面相关

• friends : 友链页面全局字段，删除此字段以禁止自动生成友链页面
  • href : 友链页面的路径，如friends表示yoursite.ltd/friends/的路径，留空此字段会使用Tag模式
  • page : 页面相关的参数，您可以配置任意多您需要的页面参数，提供的样例可供您参考
  • list : 友链列表，您可以参照提供的样例进行对应的复制修改，每一项可以提供显示的名字(name)、简介(bio)、头像链接(avatar)和目标站点链接(link)，无用项建议留空（而不是直接删除）
  • verify : 是否在每次启动时验证友联的可访问性

- Misc 杂项

• showWordCountEstimateWavy : 在文章字数处显示表示大约字数的波浪号

文章页面

配置路径：顶部，文章信息区 (Front-Matter)

• pic : 可以指定这篇文章是否使用自定义的缩略图名称（在文章资源文件夹内），而不是使用随机化的图标

• sticky : (number)重要的文章，把它们置顶吧！数字越大优先级越高哦~

• comments : (true/false)是否为单篇文章指定开启或关闭评论区

• toc： (true/false)该文章是否需要生成目录

• only： 指定文章显示的位置，有以下关键词：

  • home: 在首页显示
  • category: 在分类页显示
  • tag: 在标签页显示
    留空或是不配置此项，则文章在所有该出现的位置都会显示。
    层级之间相互平等，没有覆盖关系。
    特别地，如果配置了此项，但是使用的并不是以上的关键词（例如只留了一个- none，那么文章就被隐藏起来了）

一个完整的 Front-Matter 区样式如下（可自行删去不必要的内容）：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

title: 文章标题
date: 2018-03-24 15:31:36
categories: Demo
tags:
- Tag0
- Tag1
- Tag2
sticky: 100
pic:
comments: true
toc: true
expire: true
only:
- home
- category
- tag

模板与特定页面

项目Kratos-Rebirth-Specified-Pages已经废弃，所有功能均已内置，无需使用额外的模块。

此处给出我使用的scaffolds/post.md文件内容：

1
2
3
4
5
6
7
8
9
10

---
title: {{ title }}
date: {{ date }}
categories:
tags:
pic:
comments: true
toc: true
---

模板特有标签组件

提示信息

1
2
3
4
5

{% alertbox primary "喵呼呼o(=•ェ•=)m" %}
{% alertbox success "成功啦o(*￣▽￣*)ブ" %}
{% alertbox danger "有危险Σ(っ °Д °;)っ" %}
{% alertbox info "有消息(・∀・(・∀・(・∀・*)" %}
{% alertbox warning "当心哦≧ ﹏ ≦" %}

折叠内容

1
2
3
4
5
6
7

{% collapse 折叠框的标题 %}

被折叠的内容 1
被折叠的内容 2
...

{% endcollapse %}

1
2
3
4
5
6
7

{% collapse 折叠框的标题 open %}

被折叠的内容 1
被折叠的内容 2
...

{% endcollapse %}

提示面板

1
2
3
4
5
6
7

{% colorpanel TYPE 面板框的标题 %}

面板里的内容 1
面板里的内容 2
...

{% endcolorpanel %}

模糊字符

这里有一些被模糊的字符

1

这里有一些{% blur 被模糊的字符 %}

关于MathJax对公式进行的处理

功能已废弃，建议使用类似hexo-math类似功能的插件，相关的代码注入部分已经修复。

关于Hexo书写的小技巧

Hexo使用了MarkDown，但是在一些细节的处理上有很棒的技巧哦~

1. 文章概要
   可以将文章开头的一段作为概要显示在首页主题部分，方法就是在需要分割的地方加入<!-- more -->即可；或者可以在文章头指定excerpt

2. 图片资源
   Hexo有为每篇文章生成一个资源文件夹，可以将图片资源以{% asset_img 文件名 备注 %}的格式插入文章，本主题引入的fancybox会自动实现对文章内图片的放大功能。