Hexo 是高效的静态站点生成框架,基于 Node.js。 通过 Hexo 你可以轻松地使用 Markdown 编写文章,除了 Markdown 本身的语法之外,还可以使用 Hexo 提供的 tag 插件 来快速的插入特定形式的内容。Hexo 还拥有丰富的主题和插件。
前提环境
- 安装Node.js (Should be at least nodejs 6.9)
- 安装Git:Git命令官方文档
- Github注册并创建 github pages 库:库名为
username.github.io
,username
必须和github用户名保持一致
Hexo 相关命令
选择博客目录文件夹,右键打开 Git Bash Here
npm install hexo-cli -g # 安装hexo
hexo init username.github.io # 初始化项目文件夹
cd username.github.io # 进入项目根目录
npm install # 安装依赖包
hexo clean # 清除缓存
hexo generate # 编译文件 生成静态页面至 \public 目录
hexo serve # 本地预览 http://localhost:4000
hexo deploye # 发布 https://username.github.io
hexo new "PostName" # 新建文章至 \source\_posts
hexo new page "pageName" # 新建页面
hexo clean && hexo g -s # 清除缓存+生成+预览
hexo clean && hexo g -d # 清除缓存+生成+发布
预览
可在本地4000端口预览 http://localhost:4000
主题的配置文件,修改时会自动更新,无需重启服务器。
npm install hexo-server --save
- 修改{% label primary@站点配置文件 %}
deploy:
type: git
hexo serve
Git 配置
配置 SSH keys
ssh-keygen -t rsa -C "github的注册邮箱"
ssh -T git@github.com
git config --global user.name "username"
git config --global user.email "github注册邮箱"
部署博客到 github pages
npm install hexo-deployer-git --save
- 修改{% label primary@站点配置文件 %}
deploy:
type: git
repo: git@github.com:username/username.github.io.git # 预先创建好的库地址
branch: master # 分支名称
message: update # 自定义commit信息
hexo deploye
完成以上操作后,使用浏览器访访问 https://username.github.io 就可以成功访问我们的博客
当执行 hexo deploy
时,Hexo 会将 public 目录中的文件和目录推送至_config.yml 中指定的远端仓库和分支中,并且完全覆盖该分支下的已有内容。
此外,如果您的 Github Pages 需要使用 CNAME 文件自定义域名,请将 CNAME 文件置于 source
目录下,只有这样 hexo deploy
才能将 CNAME 文件一并推送至部署分支
站点配置文件
Hexo 框架主要配置2方面的内容:站点配置文件和主题配置文件。
站点配置文件 username.github.io\_config.yml
主题配置文件 username.github.io\themes\next\_config.yml
站点配置文件建议参考中文官方文档
站点配置主要分为几块:
Site |
网站 |
title: title |
网站标题 |
subtitle: ∞ |
网站子标题 |
description: 个人技术博客 |
网站的描述性 |
keywords: |
网站的关键字 |
author: name |
网站的作者 |
language: zh-CN |
网站采用语言,与/theme/next/languages/zh-CN.yml下的文件名对应 |
timezone: |
网站的时区 |
URL |
url配置 |
url: https://username.github.io |
网站的url,如果不在域名根目录,应包含子目录,且root要设置为/子目录/
|
root: / |
网站的根目录 |
permalink: :year/:month/:day/:title/ |
文章永久链接的形成模版。每一篇文章都有唯一的url。 |
permalink_defaults: |
文章永久链接中,各部分的默认值。 |
Directory |
路径配置 |
source_dir: source |
网站中源文件 |
public_dir: public |
生成的静态网站的目录 |
tag_dir: tags |
标签页所在的文件夹 |
archive_dir: archives |
文档页所在的文件夹 |
category_dir: categories |
类别页所在的文件夹 |
code_dir: downloads/code |
代码页所在的文件夹 |
i18n_dir: :lang |
国际语言所在的文件夹 |
skip_render: |
忽略文档清单 |
Writing |
写作设置 |
new_post_name: :title.md |
默认新建文档名,:title 为变量,指文档标题,也可用其他变量 |
default_layout: post |
新建文档的默认布局 |
titlecase: false |
是否要把标题中的首字符大写 |
external_link: true |
是否要在新开tab中打开外链 |
filename_case: 0 |
文件名是否小写敏感 |
render_drafts: false |
是否渲染草稿 |
post_asset_folder: false |
是否启用资源文件夹。如启用,新建文档同时建立同名的资源文件夹 |
relative_link: false |
是否把站内资源的链接改为站内相对链接。建议关闭。 |
future: true |
文档中指定为未来时间创建 |
highlight:
enable: true # 是否开启代码高亮功能
line_number: true # 代码块中是否在前面加上行号
auto_detect: false # 是否自动检测代码块的语言
tab_replace: # 用什么字符来代替tab(`\t`)字符。
主页设置
index_generator:
path: '' # 主页所在路径,默认为''
per_page: 10 # 主页的索引页包含文章数量,如未定义,则采用根目录下的`per_page`值
order_by: -date # 文章(Post类型)排序属性,`-`为降序
archive_generator: # 归档页
per_page: 20
yearly: true
monthly: true
tag_generator: # 标签页
per_page: 10
Category & Tag |
分类和标签 |
default_category: uncategorized |
对文档的默认分类 |
category_map: |
对文档中的分类字段进行映射,建立分类文件夹时采用映射后的字符串 |
tag_map: |
对文档中的标签字段进行映射,建立标签文件夹时采用映射后的字符串 |
per_page: 10 |
主页/分类/标签/存档等类型索引页包含文章数量 |
pagination_dir: page |
分页所在文件夹 |
接下来是扩展(Extensions),放置插件和主题。
theme: next # 更换主题
写作模板
在新建文章时,Hexo 会根据 scaffolds
文件夹内相对应的模板来建立文件
Front-matter 是文件最上方以 ---
分隔的区域,用于指定个别文件的变量,举例来说:
---
title: Hello World
date: 2013/7/13 20:46:25
---
参数 |
描述 |
默认值 |
layout |
布局 |
|
title |
标题 |
|
date |
建立日期 |
文件建立日期 |
updated |
更新日期 |
文件更新日期 |
comments |
开启文章的评论功能 |
true |
tags |
标签(不适用于分页) |
|
categories |
分类(不适用于分页) |
|
permalink |
覆盖文章网址 |
|
keywords |
仅用于 meta 标签和 Open Graph 的关键词(不推荐使用) |
|
分类和标签
可以在 Front-matter 中设置分类和标签。
categories:
- Diary
- Sunday
tags:
- Games
文章摘要和截断
在文章中使用 <!-- more -->
,那么 <!-- more -->
之前的文字将会被视为摘要,在主页中展示。
置顶和置顶标签
修改Hexo文件夹下的node_modules/hexo-generator-index/lib/generator.js
,在生成文章之前进行文章sticky值排序。
以下是最终的generator.js内容
'use strict';
var pagination = require('hexo-pagination');
module.exports = function(locals) {
var config = this.config;
var posts = locals.posts.sort(config.index_generator.order_by);
// -----------------需要添加的代码------------------------
posts.data = posts.data.sort(function(a, b) {
if(a.sticky && b.sticky) { // 两篇文章sticky都有定义
if(a.sticky == b.sticky) return b.date - a.date; // 若sticky值一样则按照文章日期降序排
else return b.sticky - a.sticky; // 否则按照sticky值降序排
}
else if(a.sticky && !b.sticky) { // 以下是只有一篇文章sticky有定义
return -1;
}
else if(!a.sticky && b.sticky) {
return 1;
}
else return b.date - a.date; // 都没定义按照文章日期降序排
});
//-------------------------分割线-----------------------
var paginationDir = config.pagination_dir || 'page';
var path = config.index_generator.path || '';
return pagination(path, posts, {
perPage: config.index_generator.per_page,
layout: ['index', 'archive'],
format: paginationDir + '/%d/',
data: {
__index: true
}
});
};
修改完成后,只需要在front-matter中设置需要置顶文章的 sticky: true
。同时sticky也决定了是否添加置顶标签。
也可以设置sticky值为数字,将会根据sticky值大小来选择置顶顺序,sticky值越大越靠前。
需要注意的是,这个文件不是主题的一部分,也不是Git管理的,备份的时候比较容易忽略。
本地图片链接
- 如果你的Hexo项目中只有少量图片,那最简单的方法就是将它们放在
source/images
文件夹中。然后通过类似于 ![](/images/image.jpg)
或{% asset_img /images/image.jpg %}
的方法访问它们。
- 对于那些想要更有规律地提供图片和其他资源以及想要将他们的资源分布在各个文章上的人来说,Hexo也提供了更组织化的方式来管理资源。
需要首先修改站点配置文件 post_asset_folder: true
打开资源文件夹。
打开当资源文件管理功能打开后,Hexo将会在你每一次通过 hexo new [layout] <title>
命令创建新文章时自动创建一个文件夹。这个资源文件夹将会有与这个文章文件一样的名字。将所有与你的文章有关的资源放在这个关联文件夹中之后,你可以通过相对路径 ![](image.jpg)
来引用它们。
踩过的坑
skip_render
:跳过指定文件的渲染。匹配到的文件将会被不做改动的复制到 public
目录中。
-
skip_render: "mypage/**"
将会直接将 source/mypage/
下的所有文件和目录不做改动地输出到 ‘public’ 目录
注意:这里只能填相对于source文件夹的相对路径。千万不要手贱加上个/
-
skip_render: "_posts/test-post.md"
这将会忽略对 ‘test-post.md’ 的渲染
-
skip_render: "mypage/*"
将会忽略source/mypage/
文件夹下所有文件的渲染
-
skip_render: "mypage/*.html"
将会忽略source/mypage/
文件夹下.html
文件
-
如果要忽略多个路径的文件或目录,可以这样配置:
skip_render:
- "_posts/test-post.md"
- "mypage/*"
参考链接:
Github+Hexo搭建专属自己的博客
HEXO添加置顶功能