辅助函数（Helpers）

辅助函数帮助您在模版中快速插入内容。

网址

url_for

在路径前加上根路径，从 Hexo 2.7 开始您应该使用此函数，避免使用 config.root + path。

<%- url_for(path) %>

relative_url

取得与 from 相对的 to 路径。

    <%- relative_url(from, to) %>  

gravatar

插入 Gravatar 图片。

    <%- gravatar(email, [size]);  

示例：

<%- gravatar('a@abc.com') %>
// http://www.gravatar.com/avatar/b9b00e66c6b8a70f88c73cb6bdb06787

<%- gravatar('a@abc.com', 40) %>
// http://www.gravatar.com/avatar/b9b00e66c6b8a70f88c73cb6bdb06787?s=40

HTML 标签

css

载入 CSS 文件。path 可以是数组或字符串，如果 path 开头不是 / 或任何协议，则会自动加上根路径；如果后面没有加上 .css 扩展名的话，也会自动加上。

<%- css(path, ...) %>

示例：

<%- css('style.css') %>
// <link rel="stylesheet" href="/style.css" type="text/css">

<%- css(['style.css', 'screen.css']) %>
// <link rel="stylesheet" href="/style.css" type="text/css">
// <link rel="stylesheet" href="/screen.css" type="text/css">

js

载入 JavaScript 文件。path 可以是数组或字符串，如果 path 开头不是 / 或任何协议，则会自动加上根路径；如果后面没有加上 .js 扩展名的话，也会自动加上。

<%- js(path, ...) %>

示例：

<%- js('script.js') %>
// <script type="text/javascript" src="/script.js"></script>

<%- js(['script.js', 'gallery.js']) %>
// <script type="text/javascript" src="/script.js"></script>
// <script type="text/javascript" src="/gallery.js"></script>

link_to

插入链接。

    <%- link_to(path, [text], [options]) %>  

参数	描述	默认值
external	在新视窗打开链接	false
class	Class 名称
id	ID

示例：

<%- link_to('http://www.google.com') %>
// <a href="http://www.google.com" title="http://www.google.com">http://www.google.com</a>

<%- link_to('http://www.google.com', 'Google') %>
// <a href="http://www.google.com" title="Google">Google</a>

<%- link_to('http://www.google.com', 'Google', {external: true}) %>
// <a href="http://www.google.com" title="Google" target="_blank" rel="external">Google</a>

mail_to

插入电子邮箱链接。

    <%- mail_to(path, [text], [options]) %>  

参数	描述
class	Class 名称
id	ID
subject	邮件主题
cc	抄送（CC）
bcc	密送（BCC）
body	邮件内容

示例：

<%- mail_to('a@abc.com') %>
// <a href="mailto:a@abc.com" title="a@abc.com">a@abc.com</a>

<%- mail_to('a@abc.com', 'Email') %>
// <a href="mailto:a@abc.com" title="Email">Email</a>

image_tag

插入图片。

    <%- image_tag(path, [options]) %>  

参数	描述
alt	图片的替代文字
class	Class 名称
id	ID
width	图片宽度
height	图片高度

favicon_tag

插入 favicon。

<%- favicon_tag(path) %>

feed_tag

插入 feed 链接。

    <%- feed_tag(path, [options]) %>  

参数	描述	默认值
title	Feed 标题
type	Feed 类型	atom

条件函数

is_current

检查 path 是否符合目前页面的网址。开启 strict 选项启用严格比对。

    <%- is_current(path, [strict]) %>  

is_home

检查目前是否为首页。

<%- is_home() %>

is_post

检查目前是否为文章。

<%- is_post() %>

is_archive

检查目前是否为存档页面。

<%- is_archive() %>

is_year

检查目前是否为年度归档页面。

<%- is_year() %>

is_month

检查目前是否为月度归档页面。

<%- is_month() %>

is_category

检查目前是否为分类归档页面。

<%- is_category() %>

is_tag

检查目前是否为标签归档页面。

<%- is_tag() %>

字符串处理

trim

清除字符串开头和结尾的空格。

<%- trim(string) %>

strip_html

清除字符串中的 HTML 标签。

    <%- strip_html(string) %>  

示例：

    <%- strip_html('It's not important anymore!') %>  
    // It's not important anymore!  

titlecase

把字符串转换为正确的 Title case。

<%- titlecase(string) %>

示例：

    <%- titlecase('this is an apple') %>  
    # This is an Apple  

markdown

使用 Markdown 解析字符串。

<%- markdown(str) %>

示例：

<%- markdown('make me **strong**') %>
// make me <strong>strong</strong>

render

解析字符串。

    <%- render(str, engine, [options]) %>  

word_wrap

使每行的字符串长度不超过 length。length 预设为 80。

    <%- word_wrap(str, [length]) %>  

示例：

<%- word_wrap('Once upon a time', 8) %>
// Once upon\n a time

truncate

移除超过 length 长度的字符串。

    <%- truncate(text, length) %>  

示例：

<%- truncate('Once upon a time in a world far far away', 16) %>
// Once upon a time

模板

partial

载入其他模板文件，您可在 locals 设定区域变量。

    <%- partial(layout, [locals], [options]) %>  

参数	描述	默认值
cache	缓存（使用 Fragment cache）	false
only	限制局部变量。在模板中只能使用 locals 中设定的变量。	false

fragment_cache

局部缓存。它储存局部内容，下次使用时就能直接使用缓存。

    <%- fragment_cache(id, fn);  

示例：

    <%- fragment_cache('header', function(){  
      return '';  
    }) %>  

日期与时间

date

插入格式化的日期。date 可以是 UNIX 时间、ISO 字符串、Date 对象或 Moment.js 对象。format 默认为 date_format 配置信息。

    <%- date(date, [format]) %>  

示例：

<%- date(Date.now()) %>
// Jan 1, 2013

<%- date(Date.now(), 'YYYY/M/D') %>
// 2013/1/1

date_xml

插入 XML 格式的日期。date 可以是 UNIX 时间、ISO 字符串、Date 对象或 Moment.js 对象。

<%- date_xml(date) %>

示例：

<%- date_xml(Date.now()) %>
// 2013-01-01T00:00:00.000Z

time

插入格式化的时间。date 可以是 UNIX 时间、ISO 字符串、Date 对象或 [Moment.js][1] 对象。format 默认为 time_format 配置信息。

    <%- time(date, [format]) %>  

示例：

<%- time(Date.now()) %>
// 13:05:12

<%- time(Date.now(), 'h:mm:ss a') %>
// 1:05:12 pm

full_date

插入格式化的日期和时间。date 可以是 UNIX 时间、ISO 字符串、Date 对象或 Moment.js 对象。format 默认为 time_format 配置信息。

    <%- full_date(date, [format]) %>  

示例：

<%- full_date(new Date()) %>
// Jan 1, 2013 0:00:00

<%- full_date(new Date(), 'dddd, MMMM Do YYYY, h:mm:ss a') %>
// Tuesday, January 1st 2013, 12:00:00 am

moment

Moment.js 函数库。

列表

list_categories

插入分类列表。

    <%- list_categories([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	改变分类名称显示方法的函数

list_tags

插入标签列表。

    <%- list_tags([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

插入归档列表。

    <%- 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

插入文章列表。

    <%- 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

插入标签云。

    <%- 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)）或 [颜色关键字][2]。此变量仅在 color 参数开启时才有用。
end_color	结束的颜色。您可使用十六进位值（#b700ff），rgba（rgba(183, 0, 255, 1)），hsla（hsla(283, 100%, 50%, 1)）或 [颜色关键字][2]。此变量仅在 color 参数开启时才有用。

其他

paginator

插入分页链接。

    <%- paginator(options) %>  

参数	描述	默认值
base	基础网址	/
format	网址格式	page/%d/
total	分页总数	1
current	目前页数	0
prev_text	上一页链接的文字。仅在 prev_next 设定开启时才有用。	Prev
next_text	下一页链接的文字。仅在 prev_next 设定开启时才有用。	Next
space	空白文字	&hellp;
prev_next	显示上一页和下一页的链接	true
end_size	显示于两侧的页数	1
mid_size	显示于中间的页数	2
show_all	显示所有页数。如果开启此参数的话，end_size 和 mid_size 就没用了。	false

search_form

插入 Google 搜索框。

    <%- search_form(options) %>  

参数	描述	默认值
class	表单的 class name	search-form
text	搜索提示文字	Search
button	显示搜索按钮。此参数可为布尔值（boolean）或字符串，当设定是字符串的时候，即为搜索按钮的文字。	false

number_format

格式化数字。

    <%- number_format(number, [options]) %>  

参数	描述	默认值
precision	数字精度。此选项可为 false 或非负整数。	false
delimiter	千位数分隔符号	,
separator	整数和小数之间的分隔符号	.

示例：

<%- number_format(12345.67, {precision: 1}) %>
// 12,345.68

<%- number_format(12345.67, {precision: 4}) %>
// 12,345.6700

<%- number_format(12345.67, {precision: 0}) %>
// 12,345

<%- number_format(12345.67, {delimiter: ''}) %>
// 12345.67

<%- number_format(12345.67, {separator: '/'}) %>
// 12,345/67

open_graph

插入 open graph 资源。

    <%- 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) 并插入目录。

    <%- toc(str, [options]) %>  

参数	描述	默认值
class	Class 名称	toc
list_number	显示编号	true

示例：

<%- toc(page.content) %>