官方文档
https://hexo.io/zh-cn/docs/
init
新建一个网站。如果没有设置 folder
,Hexo 默认在目前的文件夹建立网站。
new
1
| $ hexo new [layout] <title>
|
新建一篇文章。如果没有设置 layout
的话,默认使用 _config.yml 中的 default_layout
参数代替。如果标题包含空格的话,请使用引号括起来。
generate
生成静态文件。
选项 |
描述 |
-d , --deploy |
文件生成后立即部署网站 |
-w , --watch |
监视文件变动 |
该命令可以简写为
publish
1
| $ hexo publish [layout] <filename>
|
发表草稿。
server
启动服务器。默认情况下,访问网址为: http://localhost:4000/
。
选项 |
描述 |
-p , --port |
重设端口 |
-s , --static |
只使用静态文件 |
-l , --log |
启动日记记录,使用覆盖记录格式 |
deploy
部署网站。
参数 |
描述 |
-g , --generate |
部署之前预先生成静态文件 |
该命令可以简写为:
render
1
| $ hexo render <file1> [file2] ...
|
渲染文件。
参数 |
描述 |
-o , --output |
设置输出路径 |
migrate
从其他博客系统 迁移内容。
clean
清除缓存文件 (db.json
) 和已生成的静态文件 (public
)。
在某些情况(尤其是更换主题后),如果发现您对站点的更改无论如何也不生效,您可能需要运行该命令。
list
列出网站资料。
version
显示 Hexo 版本。
选项
安全模式
在安全模式下,不会载入插件和脚本。当您在安装新插件遭遇问题时,可以尝试以安全模式重新执行。
调试模式
在终端中显示调试信息并记录到 debug.log
。当您碰到问题时,可以尝试用调试模式重新执行一次,并 提交调试信息到 GitHub。
简洁模式
隐藏终端信息。
自定义配置文件的路径
1
| $ hexo --config custom.yml
|
自定义配置文件的路径,执行后将不再使用 _config.yml
。
显示草稿
显示 source/_drafts
文件夹中的草稿文章。
自定义 CWD
1
| $ hexo --cwd /path/to/cwd
|
自定义当前工作目录(Current working directory)的路径。
建站
安装 Hexo 完成后,请执行下列命令,Hexo 将会在指定文件夹中新建所需要的文件。
1 2 3
| $ hexo init <folder> $ cd <folder> $ npm install
|
新建完成后,指定文件夹的目录如下:
1 2 3 4 5 6 7 8
| . ├── _config.yml ├── package.json ├── scaffolds ├── source | ├── _drafts | └── _posts └── themes
|
_config.yml
网站的 配置 信息,您可以在此配置大部分的参数。
package.json
应用程序的信息。EJS, Stylus 和 Markdown renderer 已默认安装,您可以自由移除。
package.json1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
| { "name": "hexo-site", "version": "0.0.0", "private": true, "hexo": { "version": "" }, "dependencies": { "hexo": "^3.0.0", "hexo-generator-archive": "^0.1.0", "hexo-generator-category": "^0.1.0", "hexo-generator-index": "^0.1.0", "hexo-generator-tag": "^0.1.0", "hexo-renderer-ejs": "^0.1.0", "hexo-renderer-stylus": "^0.2.0", "hexo-renderer-marked": "^0.2.4", "hexo-server": "^0.1.2" } }
|
scaffolds
模版 文件夹。当您新建文章时,Hexo 会根据 scaffold 来建立文件。
Hexo的模板是指在新建的markdown文件中默认填充的内容。例如,如果您修改scaffold/post.md中的Front-matter内容,那么每次新建一篇文章时都会包含这个修改。
source
资源文件夹是存放用户资源的地方。除 _posts
文件夹之外,开头命名为 _
(下划线)的文件 / 文件夹和隐藏的文件将会被忽略。Markdown 和 HTML 文件会被解析并放到 public
文件夹,而其他文件会被拷贝过去。
themes
主题 文件夹。Hexo 会根据主题来生成静态页面。
配置
您可以在 _config.yml
中修改大部份的配置。
网站
参数 |
描述 |
title |
网站标题 |
subtitle |
网站副标题 |
description |
网站描述 |
author |
您的名字 |
language |
网站使用的语言 |
timezone |
网站时区。Hexo 默认使用您电脑的时区。时区列表。比如说:America/New_York , Japan , 和 UTC 。 |
其中,description
主要用于SEO,告诉搜索引擎一个关于您站点的简单描述,通常建议在其中包含您网站的关键词。author
参数用于主题显示文章的作者。
网址
参数 |
描述 |
默认值 |
url |
网址 |
|
root |
网站根目录 |
|
permalink |
文章的 永久链接 格式 |
:year/:month/:day/:title/ |
permalink_defaults |
永久链接中各部分的默认值 |
|
网站存放在子目录如果您的网站存放在子目录中,例如 http://yoursite.com/blog
,则请将您的 url
设为 http://yoursite.com/blog
并把 root
设为 /blog/
。
目录
参数 |
描述 |
默认值 |
source_dir |
资源文件夹,这个文件夹用来存放内容。 |
source |
public_dir |
公共文件夹,这个文件夹用于存放生成的站点文件。 |
public |
tag_dir |
标签文件夹 |
tags |
archive_dir |
归档文件夹 |
archives |
category_dir |
分类文件夹 |
categories |
code_dir |
Include code 文件夹 |
downloads/code |
i18n_dir |
国际化(i18n)文件夹 |
:lang |
skip_render |
跳过指定文件的渲染,您可使用 glob 表达式来匹配路径。 |
|
提示如果您刚刚开始接触Hexo,通常没有必要修改这一部分的值。
文章
参数 |
描述 |
默认值 |
new_post_name |
新文章的文件名称 |
:title.md |
default_layout |
预设布局 |
post |
auto_spacing |
在中文和英文之间加入空格 |
false |
titlecase |
把标题转换为 title case |
false |
external_link |
在新标签中打开链接 |
true |
filename_case |
把文件名称转换为 (1) 小写或 (2) 大写 |
0 |
render_drafts |
显示草稿 |
false |
post_asset_folder |
启动 Asset 文件夹 |
false |
relative_link |
把链接改为与根目录的相对位址 |
false |
future |
显示未来的文章 |
true |
highlight |
代码块的设置 |
|
相对地址默认情况下,Hexo生成的超链接都是绝对地址。例如,如果您的网站域名为example.com
,您有一篇文章名为hello
,那么绝对链接可能像这样:http://example.com/hello.html
,它是绝对于域名的。相对链接像这样:/hello.html
,也就是说,无论用什么域名访问该站点,都没有关系,这在进行反向代理时可能用到。通常情况下,建议使用绝对地址。
分类 & 标签
参数 |
描述 |
默认值 |
default_category |
默认分类 |
uncategorized |
category_map |
分类别名 |
|
tag_map |
标签别名 |
|
日期 / 时间格式
Hexo 使用 Moment.js 来解析和显示时间。
参数 |
描述 |
默认值 |
date_format |
日期格式 |
YYYY-MM-DD |
time_format |
时间格式 |
H:mm:ss |
分页
参数 |
描述 |
默认值 |
per_page |
每页显示的文章量 (0 = 关闭分页功能) |
10 |
pagination_dir |
分页目录 |
page |
扩展
参数 |
描述 |
theme |
当前主题名称。值为false 时禁用主题 |
deploy |
部署部分的设置 |
部署
Hexo 提供了快速方便的一键部署功能,让您只需一条命令就能将网站部署到服务器上。
在开始之前,您必须先在 _config.yml
中修改参数,一个正确的部署配置中至少要有 type
参数,例如:
您可同时使用多个 deployer,Hexo 会依照顺序执行每个 deployer。
1 2 3 4 5
| deploy: - type: git repo: - type: heroku repo:
|
缩进YAML依靠缩进来确定元素间的从属关系。因此,请确保每个deployer的缩进长度相同,并且使用空格缩进。
Git
安装 hexo-deployer-git。
1
| $ npm install hexo-deployer-git --save
|
修改配置。
1 2 3 4 5
| deploy: type: git repo: <repository url> branch: [branch] message: [message]
|
参数 |
描述 |
repo |
库(Repository)地址 |
branch |
分支名称。如果您使用的是 GitHub 或 GitCafe 的话,程序会尝试自动检测。 |
message |
自定义提交信息 (默认为 Site updated: {{ now('YYYY-MM-DD HH:mm:ss') }} ) |
Heroku
安装 hexo-deployer-heroku。
1
| $ npm install hexo-deployer-heroku --save
|
修改配置。
1 2 3 4
| deploy: type: heroku repo: <repository url> message: [message]
|
参数 |
描述 |
repo |
Heroku 库(Repository)地址 |
message |
自定提交信息 (默认为 Site updated: {{ now('YYYY-MM-DD HH:mm:ss') }} ) |
Rsync
安装 hexo-deployer-rsync。
1
| $ npm install hexo-deployer-rsync --save
|
修改配置。
1 2 3 4 5 6 7 8 9
| deploy: type: rsync host: <host> user: <user> root: <root> port: [port] delete: [true|false] verbose: [true|false] ignore_errors: [true|false]
|
参数 |
描述 |
默认值 |
host |
远程主机的地址 |
|
user |
使用者名称 |
|
root |
远程主机的根目录 |
|
port |
端口 |
22 |
delete |
删除远程主机上的旧文件 |
true |
verbose |
显示调试信息 |
true |
ignore_errors |
忽略错误 |
false |
rsync部署模块的工作方式需要注意的是,要求您提供的实际上是一个能通过SSH登陆远程主机的Linux用户。Hexo会自动处理关于rsync使用的一切操作。因此,您需要在远程主机上为您的Hexo站点建立一个用户,并允许其通过SSH登陆。不过,这里的port
,的确是指rsync监听的端口,请确保防火墙打开了该端口。
OpenShift
安装 hexo-deployer-openshift。
1
| $ npm install hexo-deployer-openshift --save
|
修改配置。
1 2 3 4
| deploy: type: openshift repo: <repository url> message: [message]
|
参数 |
描述 |
repo |
OpenShift 库(Repository)地址 |
message |
自定提交信息 (默认为 Site updated: {{ now('YYYY-MM-DD HH:mm:ss') }} ) |
FTPSync
安装 hexo-deployer-ftpsync。
1
| $ npm install hexo-deployer-ftpsync --save
|
修改配置。
1 2 3 4 5 6 7 8 9 10
| deploy: type: ftpsync host: <host> user: <user> pass: <password> remote: [remote] port: [port] ignore: [ignore] connections: [connections] verbose: [true|false]
|
参数 |
描述 |
默认值 |
host |
远程主机的地址 |
|
user |
使用者名称 |
|
pass |
密码 |
|
remote |
远程主机的根目录 |
/ |
port |
端口 |
21 |
ignore |
忽略的文件或目录 |
|
connections |
使用的连接数 |
1 |
verbose |
显示调试信息 |
false |
FTP部署可能出现的问题您可能需要预先通过其他方式将所有文件上传到远程主机中。否则初次使用ftpsync插件就可能出现报错。另外,由于FTP协议的特征,它每传送一个文件就需要一次握手,相对速度较慢。
其他方法
Hexo 生成的所有文件都放在 public
文件夹中,您可以将它们复制到您喜欢的地方。
变量
全局变量
变量 |
描述 |
site |
网站变量 |
page |
针对该页面的内容以及 front-matter 所设定的变量。 |
config |
网站配置 |
theme |
主题配置。继承自网站配置。 |
_ (单下划线) |
Lodash 函数库 |
path |
当前页面的路径(不含根路径) |
url |
当前页面的完整网址 |
env |
环境变量 |
网站变量
变量 |
描述 |
site.posts |
所有文章 |
site.pages |
所有分页 |
site.categories |
所有分类 |
site.tags |
所有标签 |
页面变量
页面(page)
变量 |
描述 |
page.title |
页面标题 |
page.date |
页面建立日期(Moment.js 对象) |
page.updated |
页面更新日期(Moment.js 对象) |
page.comments |
留言是否开启 |
page.layout |
布局名称 |
page.content |
页面的完整内容 |
page.excerpt |
页面摘要 |
page.more |
除了页面摘要的其余内容 |
page.source |
页面原始路径 |
page.full_source |
页面的完整原始路径 |
page.path |
页面网址(不含根路径)。我们通常在主题中使用 url_for(page.path) 。 |
page.permalink |
页面的完整网址 |
page.prev |
上一个页面。如果此为第一个页面则为 null 。 |
page.next |
下一个页面。如果此为最后一个页面则为 null 。 |
page.raw |
文章的原始内容 |
page.photos |
文章的照片(用于相簿) |
page.link |
文章的外部链接(用于链接文章) |
文章 (post): 和 page
布局类似,但是添加了下列变量。
Variable |
Description |
page.published |
如果该文章已发布则为True |
page.categories |
该文章的所有分类 |
page.tags |
该文章的所有标签 |
首页(index)
变量 |
描述 |
page.per_page |
每页显示的文章数量 |
page.total |
总文章数 |
page.current |
目前页数 |
page.current_url |
目前分页的网址 |
page.posts |
本页文章 |
page.prev |
上一页的页数。如果此页是第一页的话则为 0 。 |
page.prev_link |
上一页的网址。如果此页是第一页的话则为 '' 。 |
page.next |
下一页的页数。如果此页是最后一页的话则为 0 。 |
page.next_link |
下一页的网址。如果此页是最后一页的话则为 '' 。 |
page.path |
当前页面的路径(不含根目录)。我们通常在主题中使用 url_for(page.path) 。 |
归档 (archive):与 index
布局相同,但新增以下变量。
变量 |
描述 |
page.archive |
等于 true |
page.year |
年份归档 (4位) |
page.month |
月份归档 (没有前导零的2位数) |
分类 (category):与 index
布局相同,但新增以下变量。
标签 (tag):与 index
布局相同,但新增以下变量。
辅助函数(Helpers)
辅助函数帮助您在模版中快速插入内容。辅助函数不能在源文件中使用。
网址
url_for
在路径前加上根路径,从 Hexo 2.7 开始您应该使用此函数而不是 config.root + path
。
relative_url
取得与 from
相对的 to
路径。
1
| <%- relative_url(from, to) %>
|
gravatar
插入 Gravatar 图片。
如果你不指定 options
参数,将会应用默认参数。否则,你可以将其设置为一个数字,这个数字将会作为 Gravatar 的大小参数。最后,如果你设置它一个对象,它将会被转换为 Gravatar 的一个查询字符串参数。
1
| <%- gravatar(email, [options]);
|
示例:
1 2 3 4 5 6 7 8
| <%- gravatar('a@abc.com') %>
<%- gravatar('a@abc.com', 40) %>
<%- gravatar('a@abc.com' {s: 40, d: 'http://example.com/image.png'}) %>
|
HTML 标签
css
载入 CSS 文件。path
可以是数组或字符串,如果 path
开头不是 /
或任何协议,则会自动加上根路径;如果后面没有加上 .css
扩展名的话,也会自动加上。
示例:
1 2 3 4 5 6
| <%- css('style.css') %>
<%- css(['style.css', 'screen.css']) %>
|
js
载入 JavaScript 文件。path
可以是数组或字符串,如果 path
开头不是 /
或任何协议,则会自动加上根路径;如果后面没有加上 .js
扩展名的话,也会自动加上。
示例:
1 2 3 4 5 6
| <%- js('script.js') %>
<%- js(['script.js', 'gallery.js']) %>
|
link_to
插入链接。
1
| <%- link_to(path, [text], [options]) %>
|
参数 |
描述 |
默认值 |
external |
在新视窗打开链接 |
false |
class |
Class 名称 |
|
id |
ID |
|
示例:
1 2 3 4 5 6 7 8
| <%- link_to('http://www.google.com') %>
<%- link_to('http://www.google.com', 'Google') %>
<%- link_to('http://www.google.com', 'Google', {external: true}) %>
|
mail_to
插入电子邮箱链接。
1
| <%- mail_to(path, [text], [options]) %>
|
参数 |
描述 |
class |
Class 名称 |
id |
ID |
subject |
邮件主题 |
cc |
抄送(CC) |
bcc |
密送(BCC) |
body |
邮件内容 |
示例:
1 2 3 4 5
| <%- mail_to('a@abc.com') %>
<%- mail_to('a@abc.com', 'Email') %>
|
image_tag
插入图片。
1
| <%- image_tag(path, [options]) %>
|
参数 |
描述 |
alt |
图片的替代文字 |
class |
Class 名称 |
id |
ID |
width |
图片宽度 |
height |
图片高度 |
favicon_tag
插入 favicon。
1
| <%- favicon_tag(path) %>
|
feed_tag
插入 feed 链接。
1
| <%- feed_tag(path, [options]) %>
|
参数 |
描述 |
默认值 |
title |
Feed 标题 |
|
type |
Feed 类型 |
atom |
条件函数
is_current
检查 path
是否符合目前页面的网址。开启 strict
选项启用严格比对。
1
| <%- is_current(path, [strict]) %>
|
is_home
检查目前是否为首页。
is_post
检查目前是否为文章。
is_archive
检查目前是否为存档页面。
is_year
检查目前是否为年度归档页面。
is_month
检查目前是否为月度归档页面。
is_category
检查目前是否为分类归档页面。
如果给定一个字符串作为参数,将会检查目前是否为指定分类。
1 2
| <%- is_category() %> <%- is_category('hobby') %>
|
is_tag
检查目前是否为标签归档页面。
如果给定一个字符串作为参数,将会检查目前是否为指定标签。
1 2
| <%- is_tag() %> <%- is_tag('hobby') %>
|
字符串处理
trim
清除字符串开头和结尾的空格。
strip_html
清除字符串中的 HTML 标签。
1
| <%- strip_html(string) %>
|
示例:
1 2
| <%- strip_html('It's not <b>important</b> anymore!') %> // It's not important anymore!
|
titlecase
把字符串转换为正确的 Title case。
1
| <%- titlecase(string) %>
|
示例:
1 2
| <%- titlecase('this is an apple') %> # This is an Apple
|
markdown
使用 Markdown 解析字符串。
示例:
1 2
| <%- markdown('make me **strong**') %>
|
render
解析字符串。
1
| <%- render(str, engine, [options]) %>
|
word_wrap
使每行的字符串长度不超过 length
。length
预设为 80。
1
| <%- word_wrap(str, [length]) %>
|
示例:
1 2
| <%- word_wrap('Once upon a time', 8) %>
|
truncate
移除超过 length
长度的字符串。
1
| <%- truncate(text, length) %>
|
示例:
1 2 3 4 5 6 7 8
| <%- truncate('Once upon a time in a world far far away', {length: 17}) %>
<%- truncate('Once upon a time in a world far far away', {length: 17, separator: ' '}) %>
<%- truncate('And they found that many people were sleeping better.', {length: 25, omission: '... (continued)'}) %>
|
模板
partial
载入其他模板文件,您可在 locals
设定区域变量。
1
| <%- partial(layout, [locals], [options]) %>
|
参数 |
描述 |
默认值 |
cache |
缓存(使用 Fragment cache) |
false |
only |
限制局部变量。在模板中只能使用 locals 中设定的变量。 |
false |
fragment_cache
局部缓存。它储存局部内容,下次使用时就能直接使用缓存。
1
| <%- fragment_cache(id, fn);
|
示例:
1 2 3
| <%- fragment_cache('header', function(){ return '<header></header>'; }) %>
|
日期与时间
date
插入格式化的日期。date
可以是 UNIX 时间、ISO 字符串、Date 对象或 Moment.js 对象。format
默认为 date_format
配置信息。
1
| <%- date(date, [format]) %>
|
示例:
1 2 3 4 5
| <%- date(Date.now()) %>
<%- date(Date.now(), 'YYYY/M/D') %>
|
date_xml
插入 XML 格式的日期。date
可以是 UNIX 时间、ISO 字符串、Date 对象或 Moment.js 对象。
示例:
1 2
| <%- date_xml(Date.now()) %>
|
time
插入格式化的时间。date
可以是 UNIX 时间、ISO 字符串、Date 对象或 Moment.js 对象。format
默认为 time_format
配置信息。
1
| <%- time(date, [format]) %>
|
示例:
1 2 3 4 5
| <%- time(Date.now()) %>
<%- time(Date.now(), 'h:mm:ss a') %>
|
full_date
插入格式化的日期和时间。date
可以是 UNIX 时间、ISO 字符串、Date 对象或 Moment.js 对象。format
默认为 date_format + time_format
。
1
| <%- full_date(date, [format]) %>
|
示例:
1 2 3 4 5
| <%- full_date(new Date()) %>
<%- full_date(new Date(), 'dddd, MMMM Do YYYY, h:mm:ss a') %>
|
moment
Moment.js 函数库。
列表
list_categories
插入分类列表。
1
| <%- list_categories([options]) %>
|
参数 |
描述 |
默认值 |
orderby |
分类排列方式 |
name |
order |
分类排列顺序。1 , asc 升序;-1 , desc 降序。 |
1 |
show_count |
显示每个分类的文章总数 |
true |
style |
分类列表的显示方式。使用 list 以无序列表(unordered list)方式显示。 |
list |
separator |
分类间的分隔符号。只有在 style 不是 list 时有用。 |
, |
depth |
要显示的分类层级。0 显示所有层级的分类;-1 和 0 很类似,但是显示不分层级;1 只显示第一层的分类。 |
0 |
class |
分类列表的 class 名称。 |
category |
transform |
改变分类名称显示方法的函数 |
|
插入标签列表。
1
| <%- list_tags([options]) %>
|
选项 |
描述 |
预设值 |
orderby |
标签排列方式 |
name |
order |
标签排列顺序。1 , asc 升序;-1 , desc 降序。 |
1 |
show_count |
显示每个标签的文章总数 |
true |
style |
标签列表的显示方式。使用 list 以无序列表(unordered list)方式显示。 |
list |
separator |
标签间的分隔符号。只有在 style 不是 list 时有用。 |
, |
class |
标签列表的 class 名称。 |
tag |
transform |
改变标签名称显示方法的函数 |
|
amount |
要显示的标签数量(0 = 无限制) |
0 |
list_archives
插入归档列表。
1
| <%- list_archives([options]) %>
|
参数 |
描述 |
默认值 |
type |
类型。此设定可为 yearly 或 monthly 。 |
monthly |
order |
排列顺序。1 , asc 升序;-1 , desc 降序。 |
1 |
show_count |
显示每个归档的文章总数 |
true |
format |
日期格式 |
MMMM YYYY |
style |
归档列表的显示方式。使用 list 以无序列表(unordered list)方式显示。 |
list |
separator |
归档间的分隔符号。只有在 style 不是 list 时有用。 |
, |
class |
归档列表的 class 名称。 |
archive |
transform |
改变归档名称显示方法的函数 |
|
list_posts
插入文章列表。
1
| <%- list_posts([options]) %>
|
参数 |
描述 |
默认值 |
orderby |
文章排列方式 |
date |
order |
文章排列顺序。1 , asc 升序;-1 , desc 降序。 |
-1 |
style |
文章列表的显示方式。使用 list 以无序列表(unordered list)方式显示。 |
list |
separator |
文章间的分隔符号。只有在 style 不是 list 时有用。 |
, |
class |
文章列表的 class 名称。 |
post |
amount |
要显示的文章数量(0 = 无限制) |
6 |
transform |
改变文章名称显示方法的函数 |
|
tagcloud
插入标签云。
1
| <%- tagcloud([tags], [options]) %>
|
参数 |
描述 |
默认值 |
min_font |
最小字体尺寸 |
10 |
max_font |
最大字体尺寸 |
20 |
unit |
字体尺寸的单位 |
px |
amount |
标签总量 |
40 |
orderby |
标签排列方式 |
name |
order |
标签排列顺序。1 , sac 升序;-1 , desc 降序 |
1 |
color |
使用颜色 |
false |
start_color |
开始的颜色。您可使用十六进位值(#b700ff ),rgba(rgba(183, 0, 255, 1) ),hsla(hsla(283, 100%, 50%, 1) )或 颜色关键字。此变量仅在 color 参数开启时才有用。 |
|
end_color |
结束的颜色。您可使用十六进位值(#b700ff ),rgba(rgba(183, 0, 255, 1) ),hsla(hsla(283, 100%, 50%, 1) )或 颜色关键字。此变量仅在 color 参数开启时才有用。 |
|
其他
paginator
插入分页链接。
1
| <%- paginator(options) %>
|
参数 |
描述 |
默认值 |
base |
基础网址 |
/ |
format |
网址格式 |
page/%d/ |
total |
分页总数 |
1 |
current |
目前页数 |
0 |
prev_text |
上一页链接的文字。仅在 prev_next 设定开启时才有用。 |
Prev |
next_text |
下一页链接的文字。仅在 prev_next 设定开启时才有用。 |
Next |
space |
空白文字 |
… |
prev_next |
显示上一页和下一页的链接 |
true |
end_size |
显示于两侧的页数 |
1 |
mid_size |
显示于中间的页数 |
2 |
show_all |
显示所有页数。如果开启此参数的话,end_size 和 mid_size 就没用了。 |
false |
插入 Google 搜索框。
1
| <%- search_form(options) %>
|
参数 |
描述 |
默认值 |
class |
表单的 class name |
search-form |
text |
搜索提示文字 |
Search |
button |
显示搜索按钮。此参数可为布尔值(boolean)或字符串,当设定是字符串的时候,即为搜索按钮的文字。 |
false |
格式化数字。
1
| <%- number_format(number, [options]) %>
|
参数 |
描述 |
默认值 |
precision |
数字精度。此选项可为 false 或非负整数。 |
false |
delimiter |
千位数分隔符号 |
, |
separator |
整数和小数之间的分隔符号 |
. |
示例:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
| <%- number_format(12345.67, {precision: 1}) %>
<%- number_format(12345.67, {precision: 4}) %>
<%- number_format(12345.67, {precision: 0}) %>
<%- number_format(12345.67, {delimiter: ''}) %>
<%- number_format(12345.67, {separator: '/'}) %>
|
open_graph
插入 open graph 资源。
1
| <%- open_graph([options]) %>
|
参数 |
描述 |
默认值 |
title |
页面标题 (og:title ) |
page.title |
type |
页面类型 (og:type ) |
blog |
url |
页面网址 (og:url ) |
url |
image |
页面图片 (og:image ) |
内容中的图片 |
site_name |
网站名称 (og:site_name ) |
config.title |
description |
页面描述 (og:desription ) |
内容摘要或前 200 字 |
twitter_card |
Twitter 卡片类型 (twitter:card ) |
summary |
twitter_id |
Twitter ID (twitter:creator ) |
|
twitter_site |
Twitter 网站 (twitter:site ) |
|
google_plus |
Google+ 个人资料链接 |
|
fb_admins |
Facebook 管理者 ID |
|
fb_app_id |
Facebook 应用程序 ID |
|
toc
解析内容中的标题标签 (h1~h6) 并插入目录。
1
| <%- toc(str, [options]) %>
|
参数 |
描述 |
默认值 |
class |
Class 名称 |
toc |
list_number |
显示编号 |
true |
示例:
1
| <%- toc(page.content) %>
|
本文链接:
https://netlover.cn/2018/08/01/hexo-begin.html