Skip to content
This repository has been archived by the owner on Nov 16, 2020. It is now read-only.

主题配置

showzeng edited this page Aug 29, 2018 · 7 revisions

_config.yml 配置

_config.yml 文件配置对应一些博客网站中的全局设置

一个配置文件的模板如下 (可复制并粘贴该模板覆盖原来的配置项,并按需填写):

excerpt_separator: <!--more-->

sass:
  style: compressed

defaults:
  -
    scope:
      path: ""
      type: "posts"
    values:
      layout: "post"
  -
    scope:
      path: "assets/img"
    values:
      image: true

# --- 网站信息设置 ---
# 下面填写你的博客标题
# title: Minimalism
# 下面填写你的网络常用名
# name: minimalism
# 下面填写你的座右铭或者是个性签名
# description: Minimalism is a jekyll theme for minimalist
# 你博客的 url 地址,比如:https://showzeng.github.io 或者是自定义的域名
# url: https://xxxxx.github.io
# 在页尾的版权时间信息,比如:2016-2018,默认是 2018 年
# copyright_time: 2018
# 标签页的 logo 及博客的头像,如果你想引用网络图片资源,就取消下面的注解,并填写图片资源的 url 地址
# 或者,推荐的做法是将这两个图片资源下载到本地的 /assets/img/ 文件夹下,且图片名必须命名为 favicon 和 avatar
# favicon:
# avatar:
# --- 网站信息设置 ---


# --- 文章列表页 ---
# 文章列表是否显示摘要
show_excerpt: true
# --- 文章页 ---


# --- 社交链接 ---
# 取消下面的注解,并填写相应的你要开启的社交链接
# twitter:
# weibo:
# github:
# 邮件地址前面带上 mailto:
# email: mailto:[email protected]
# RSS 订阅
rss: true
# --- 社交链接 ---


# --- 站点统计 ---
# 如果你想开启站点统计,取消下面一行注解,并填写相应统计运营商给的 id,可支持多个同时开启
# site_statistics: true
# cnzz (友盟统计)
# cnzz_id:
# Baidu (百度统计)
# baidu_id:
# Google Analytics (谷歌统计)
# google_id:
# --- 站点统计 ---


# --- 版权声明 ---
# 禁止复制 (注:启用后仅文章页和关于页禁止复制)
# lock_copy: true
# 禁止右键菜单 (注:为全局设置,启用后所有页面均无法使用右键菜单)
# lock_menu: true
# 复制文本末尾添加版权声明 (注:启用后仅文章页和关于页复制添加版权声明)
# copy_with_declaration: true
# --- 版权声明 ---


# --- 打赏设置 ---
# 开启打赏,取消下面一行注解,并将微信和支付宝的收款二维码放置在 /assets/img/ 文件夹下
# 同时图片的文件名必须为 alipay 和 wechat
# reward: true
# 打赏的推广语
# reward_description: 如果你觉得本文对你有帮助,不妨请我喝杯咖啡
# --- 打赏设置 ---


# --- 评论设置 ---
# 开启评论,取消下面一行注解,并填写相应评论运营商提供的 id,目前仅支持来必力和 gitment
# comment: true
# 来必力 uid
# livere_uid:
# gitment 用户主,即 GitHub 用户名
# gitment_owner:
# GitHub pages 仓库名,如:showzeng.github.io
# gitment_repo: 
# gitment 提供的对应 id 和 secret
# gitment_client_id:
# gitment_secret:
# --- 评论设置 ---

# 使用 gem 包安装主题的配置
# theme: jekyll-theme-minimalism
# remote_theme: showzeng/Minimalism

plugins:
  - rouge
  - kramdown
  - jekyll-feed
  - jekyll-seo-tag
  - jemoji

exclude:
  - Gemfile
  - Gemfile.lock

其实配置模板里已经注释的很清楚了,这里再挑几个重要的配置详细讲解一下。

博客的 favicon 和 头像

如果你需要从网络获取 (如第三方图床) 你的 favicon 和头像,你就取消配置项注解,并填上图片资源的 url 地址,比如:

favicon: https://www.z4a.net/images/2017/08/31/shortcut_icon.png
avatar: https://www.z4a.net/images/2017/08/31/avatar.jpg

如果你像引用本地的图片资源,且之后一起推到 GitHub 仓库里,你需要按要求将图片资源放在 /assets/img/ 下,如果不存在文件夹就创建一个,图片资源的格式任意,但是推荐将图片转化成 webp 格式 (压缩图片大小,加快博客的加载速度),但是,对应的图片资源必须命名为 faviconavatar

打赏功能

打赏功能目前定制的是微信支付和支付宝支付的样式,如果你将打赏功能开启,默认是每篇文章页的文末都会有打赏功能。而打赏功能只支持引用本地的打赏二维码图片资源,之前页想过是否需要配置引用网络资源,像 favicon 和头像一样,但觉得这样不是很安全?总之,将你的打赏二维码图片资源 (微信和支付宝生成的打赏码建议按 1:1 的大小只截取二维码部分) 放在 /assets/img/ 下,同样,如果不存在文件夹就创建一个,图片资源的格式任意,但是推荐将图片转化成 webp 格式 (压缩图片大小,加快博客的加载速度),但是,对应的图片资源必须命名为 alipaywechat

remote-theme

在使用 gem 包安装主题时,如果需要使用 bundle exec jekyll serve 本地运行预览博客,此时的配置项应该是开启 theme 配置,如下:

theme: jekyll-theme-minimalism
# remote_theme: showzeng/Minimalism

而当你预览后觉得没问题,需要推送更新时,在推送之前,则需要开启 remote theme 配置项,并注解 theme 项,如下:

# theme: jekyll-theme-minimalism
remote_theme: showzeng/Minimalism

文章中的头文件配置

文章中的头文件配置主要是打开或关闭单篇文章的一些配置选项

以下是一篇文章 (2018-08-08-example.md) 的 YAML 头信息配置示例:

---
title: "示例文章标题"
date: 2018-08-08 08:08:08 +0800
category: Demo example
tags: [Minimalism, Demo]
comment: false
reward: false
excerpt: 这是这篇文章的摘要,或者你也可以在文章正文中使用 <!--more--> 标签来截断摘要。
---

正文内容

除了 layout、title、date、category 等常规项外,你还可以使用:

  • tags (文章相关的标签)
  • comment (关闭文章评论)
  • reward (关闭文章打赏)
  • excerpt (文章摘要)

其中 category 和 tags 项一样,当有多个分类或标签时,有以下三种语法都是可行的:

---
category: Demo example
tags: Minimalism Demo

category: [Demo, example]
tags: [Minimalism, Demo]

category:
 - Demo
 - example
tags:
 - Minimalism
 - Demo
---

至于文章摘要,如果你在全局配置 (_config.yml) 中开启了:

show_excerpt: true

那么,在文章列表页,就会显示每篇文章的摘要。摘要的截取,有两种方式,一个是在 YAML 头信息中直接写出,如上 (2018-08-08-example.md) 示例,另一种是从正文内容中截取,即使用 <!--more--> 标签,例如:

---
title: "文章标题"
date: 2018-08-08 08:08:08 +0800
category: example
---

正文内容开始,但是这一段我要它作为这篇文章的摘要。

<!--more-->

下面也是正文内容。

这两种方法的区别在于,使用 YAML 头信息注明的文章摘要不会出现在文章的正文内容里,而截取摘要则是截取正文内容开头的某几个段落。我更加倾向于使用 YAML 头信息来写一个文章梗概或者文章背景来作为摘要。同时,文章摘要的分割符是可以在 config 配置文件中规定的,你可以看到模板配置文件中开头的一行:

excerpt_separator: <!--more-->

因此,你也可以设置成你自己习惯的分割符。

最后,个人建议是将关于页面的打赏和评论功能关闭,当然,这看个人喜好了,仅仅是建议而已 :p

如果你觉得配置信息不够直观或者有疑惑,还可以参考主题 demo 仓库 来查看使用方法及具体的效果