个人博客建设——Hexo的_config.yml配置参数注释

2021-11-24 16:07:09 浏览数 (1)

个人博客建设——Hexo的_config.yml配置参数注释

背景

我的CN華少博客建设也有一段时间了,这段时间想去更新一下文章,突然发现原来的源码被我不知道弄到哪里去了,于是乎我又准备重新建一个项目,并在其基础上更换一套新的模板,并与Typore中的.md文件进行使用尝试,近期这几篇可能就是这个系列来进行了。 另之前开设的SSO统一身份认证近期没有再进行更新,后续会对其进行补充,请大家持续关注。

正文

本篇用于记录我在创建后的Hexo中进行注释的_config.yml,便于后续进行修改时不记得哪个是干啥的了o(╯□╰)o,所有注释均参考了官方文档进行记录,对于其各个部分进行了模块划分,便于进行阅读使用。下面是我进行注释后的配置文件。有需要的同学可以直接拿去进行修改。

代码语言:javascript复制
######################################
# 网站
# 网站标题
title: CN華少的个人博客
# 网站副标题
subtitle: 个人博客
# 网站描述
description: ''
# 网站的关键词。支持多个关键词。
keywords: null
# 您的名字
author: CN華少
# 网站使用的语言。对于简体中文用户来说,使用不同的主题可能需要设置成不同的值,请参考你的主题的文档自行设置,常见的有 zh-Hans和 zh-CN。
language: zh-CN
# 网站时区。Hexo 默认使用您电脑的时区。请参考 时区列表 进行设置,如 America/New_York, Japan, 和 UTC 。一般的,对于中国大陆地区可以使用 Asia/Shanghai。
timezone: Asia/Shanghai
######################################
# 网址
# 网址, 必须以 http:// 或 https:// 开头
url: https://cnhuashao.com
# root  网站根目录
# 文章的 永久链接 格式
permalink: ':year/:month/:day/:title/'
# 永久链接中各部分的默认值
permalink_defaults: null
# 改写 permalink 的值来美化 URL
pretty_urls:
  # 是否在永久链接中保留尾部的 index.html,设置为 false 时去除
  trailing_index: true
  # 是否在永久链接中保留尾部的 .html, 设置为 false 时去除 (对尾部的 index.html无效)
  trailing_html: true
#####################################
# 目录
# 资源文件夹,这个文件夹用来存放内容。
source_dir: source
# 公共文件夹,这个文件夹用于存放生成的站点文件。
public_dir: public
# 标签文件夹
tag_dir: tags
# 归档文件夹
archive_dir: archives
# 分类文件夹
category_dir: categories
# Include code 文件夹,source_dir 下的子目录
code_dir: downloads/code
# 国际化(i18n)文件夹
i18n_dir: ':lang'
# 跳过指定文件的渲染。匹配到的文件将会被不做改动地复制到 public 目录中。
# 您可使用 glob 表达式来匹配路径。
skip_render: null
######################################
# 文章
# 新文章的文件名称
new_post_name: ':title.md'
# 预设布局
default_layout: post
# 把标题转换为 标题大写
titlecase: true
# 在新标签中打开链接
external_link:
  # 在新标签中打开链接
  enable: true
  # 对整个网站(site)生效或仅对文章(post)生效
  field: site
  # 需要排除的域名。主域名和子域名如 www 需分别配置
  exclude: ''
# 把文件名称转换为 (1) 小写或 (2) 大写
filename_case: 0
# 显示草稿
render_drafts: false
# 启动 Asset 文件夹 资源(Asset)代表 source 文件夹中除了文章以外的所有文件,例如图片、CSS、JS 文件等。
post_asset_folder: false
# 把链接改为与根目录的相对位址
relative_link: false
# 显示未来的文章
future: true
# 代码块的设置, 请参考 Highlight.js 进行设置
highlight:
  enable: true
  line_number: true
  auto_detect: false
  tab_replace: ''
  wrap: true
  hljs: false
# 代码块的设置, 请参考 PrismJS 进行设置
prismjs:
  enable: false
  preprocess: true
  line_number: true
  tab_replace: ''
index_generator:
  path: ''
  per_page: 10
  order_by: '-date'
###################################
# 分类 & 标签
# 默认分类
default_category: uncategorized
# 分类别名
category_map: null
# 标签别名
tag_map: null
meta_generator: true
##################################
# Hexo 使用 Moment.js 来解析和显示时间。
# 日期格式
date_format: YYYY-MM-DD
# 时间格式
time_format: HH:mm:ss
# 当 Front Matter 中没有指定 updated 时 updated 的取值
# mtime: 使用文件的最后修改时间。这是从 Hexo 3.0.0 开始的默认行为。
# date: 使用 date 作为 updated 的值。可被用于 Git 工作流之中,因为使用 Git 管理站点时,文件的最后修改日期常常会发生改变
# empty: 直接删除 updated。使用这一选项可能会导致大部分主题和插件无法正常工作。
updated_option: mtime
###################################
# 分页
# 每页显示的文章量 (0 = 关闭分页功能)
per_page: 10
# 分页目录
pagination_dir: page
##################################
# 在 Hexo 配置文件中,通过设置 include/exclude 可以让 Hexo 进行处理或忽略某些目录和文件夹。你可以使用 glob 表达式 对目录和文件进行匹配。
# Hexo 默认会忽略隐藏文件和文件夹(包括名称以下划线和 . 开头的文件和文件夹,Hexo 的 _posts 和 _data 等目录除外)。通过设置此字段将使 Hexo 处理他们并将它们复制到 source 目录下。
include: null
# Hexo 会忽略这些文件和目录
exclude: null
# Ignore files/folders
ignore: null
##################################
# 扩展
# 当前主题名称。值为false时禁用主题
theme: icarus
# 部署部分的设置
deploy:
  type: ''

# Include/Exclude Files/Folders
# include:
#  - ".nojekyll"
  # 包括 'source/css/_typing.css'
#  - "css/_typing.css"
  # 包括 'source/_css/' 中的任何文件,但不包括子目录及其其中的文件。
#  - "_css/*"
  # 包含 'source/_css/' 中的任何文件和子目录下的任何文件
#  - "_css/**/*"

#exclude:
  # 不包括 'source/js/test.js'
#  - "js/test.js"
  # 不包括 'source/js/' 中的文件、但包括子目录下的所有目录和文件
  #- "js/*"
  # 不包括 'source/js/' 中的文件和子目录下的任何文件
  #- "js/**/*"
  # 不包括 'source/js/' 目录下的所有文件名以 'test' 开头的文件,但包括其它文件和子目录下的单文件
  #- "js/test*"
  # 不包括 'source/js/' 及其子目录中任何以 'test' 开头的文件
  #- "js/**/test*"
  # 不要用 exclude 来忽略 'source/_posts/' 中的文件。你应该使用 'skip_render',或者在要忽略的文件的文件名之前加一个下划线 '_'
  # 在这里配置一个 - "_posts/hello-world.md" 是没有用的。

#ignore:
  # Ignore any folder named 'foo'.
  #- "**/foo"
  # Ignore 'foo' folder in 'themes/' only.
  #- "**/themes/*/foo"
  # Same as above, but applies to every subfolders of 'themes/'.
  #- "**/themes/**/foo"
本文声明:

本作品由 cn華少 采用 知识共享署名-非商业性使用 4.0 国际许可协议 进行许可。

0 人点赞