辅助函数(Helpers)

辅助函数帮助您在模版中快速插入内容。辅助函数不能在源文件中使用。

网址

url_for

在路径前加上根路径,从 Hexo 2.7 开始您应该使用此函数而不是 config.root + path

<%- url_for(path, [option]) %>
参数描述默认值
relative是否输出相对链接config.relative_link 的值

示例:

_config.yml
root: /blog/
<%- url_for('/a/path') %>
// /blog/a/path

是否输出相对链接,默认遵循配置文件中 relative_link 的值
例如, post/page 的相对路径值可能是 /foo/bar/index.html

_config.yml
relative_link: true
<%- url_for('/css/style.css') %>
// ../../css/style.css
/* 覆盖配置
* 即使配置文件中启用了 relative_link,你也可以使用 relative 参数禁用相对链接输出,反之亦然
*/
<%- url_for('/css/style.css', {relative: false}) %>
// /css/style.css

relative_url

取得与 from 相对的 to 路径。

<%- relative_url(from, to) %>

示例:

<%- relative_url('foo/bar/', 'css/style.css') %>
// ../../css/style.css

gravatar

根据邮箱地址返回 Gravatar 头像 URL。

如果你不指定 options 参数,将会应用默认参数。否则,你可以将其设置为一个数字,这个数字将会作为 Gravatar 的大小参数。最后,如果你设置它一个对象,它将会被转换为 Gravatar 的一个查询字符串参数。

<%- gravatar(email, [options]) %>
参数描述默认值
s图片大小80
d默认头像
f强制使用默认图象
r头像等级限制

访问 Gravatar 了解更多。

示例:

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

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

<%- gravatar('a@abc.com' {s: 40, d: 'https://via.placeholder.com/150'}) %>
// https://www.gravatar.com/avatar/b9b00e66c6b8a70f88c73cb6bdb06787?s=40&d=https%3A%2F%2Fvia.placeholder.com%2F150

full_url_for

在路径前加上根路径和域名。输出会被自动转码。

<%- full_url_for(path) %>

示例:

_config.yml
url: https://example.com/blog # example
<%- full_url_for('/a/path') %>
// https://example.com/blog/a/path

HTML 标签

css

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

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

示例:

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

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

<%- css({ href: 'style.css', integrity: 'foo' }) %>
// <link rel="stylesheet" href="/style.css" integrity="foo">

<%- css([{ href: 'style.css', integrity: 'foo' }, { href: 'screen.css', integrity: 'bar' }]) %>
// <link rel="stylesheet" href="/style.css" integrity="foo">
// <link rel="stylesheet" href="/screen.css" integrity="bar">

js

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

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

示例:

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

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

<%- js({ src: 'script.js', integrity: 'foo', async: true }) %>
// <script src="/script.js" integrity="foo" async></script>

<%- js([{ src: 'script.js', integrity: 'foo' }, { src: 'gallery.js', integrity: 'bar' }]) %>
// <script src="/script.js" integrity="foo"></script>
// <script src="/gallery.js" integrity="bar"></script>

link_to

插入链接。

<%- link_to(path, [text], [options]) %>
参数描述默认值
external在新视窗打开链接false
classClass 名称
idID

示例:

<%- 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="noopener">Google</a>

mail_to

插入电子邮箱链接。

<%- mail_to(path, [text], [options]) %>
参数描述
classClass 名称
idID
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图片的替代文字
classClass 名称
idID
width图片宽度
height图片高度

favicon_tag

插入 favicon。

<%- favicon_tag(path) %>

feed_tag

插入 feed 链接。

<%- feed_tag(path, [options]) %>
参数描述默认值
titleFeed 标题
typeFeed 类型atom

条件函数

is_current

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

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

is_home

检查当前页面是否为首页。

<%- is_home() %>

is_post

检查当前页面是否为文章。

<%- is_post() %>

is_page

检查当前页面是否为独立页面。

<%- is_page() %>

is_archive

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

<%- is_archive() %>

is_year

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

<%- is_year() %>

is_month

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

<%- is_month() %>

is_category

检查当前页面是否为分类归档页面。
如果给定一个字符串作为参数,将会检查目前是否为指定分类。

<%- is_category() %>
<%- is_category('hobby') %>

is_tag

检查当前页面是否为标签归档页面。
如果给定一个字符串作为参数,将会检查目前是否为指定标签。

<%- is_tag() %>
<%- is_tag('hobby') %>

字符串处理

trim

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

<%- trim(string) %>

strip_html

清除字符串中的 HTML 标签。

<%- strip_html(string) %>

示例:

<%- strip_html('It\'s not <b>important</b> 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

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

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

示例:

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

truncate

移除超过 length 长度的字符串。length 的默认值是 30。

<%- truncate(text, length) %>

示例:

<%- truncate('Once upon a time in a world far far away', {length: 17}) %>
// Once upon a ti...

<%- truncate('Once upon a time in a world far far away', {length: 17, separator: ' '}) %>
// Once upon a...

<%- truncate('And they found that many people were sleeping better.', {length: 25, omission: '... (continued)'}) %>
// And they f... (continued)

模板

partial

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

<%- partial(layout, [locals], [options]) %>
参数描述默认值
cache缓存(使用 Fragment cache)false
only限制局部变量。在模板中只能使用 locals 中设定的变量。false

fragment_cache

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

<%- fragment_cache(id, fn);

示例:

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

日期与时间

date

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

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

示例:

<%- date(Date.now()) %>
// 2013-01-01

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

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 对象。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 默认为 date_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([options]) %>
参数描述默认值
orderby分类排列方式name
order分类排列顺序。1, asc 升序;-1, desc 降序。1
show_count显示每个分类的文章总数true
style分类列表的显示方式。使用 list 以无序列表(unordered list)方式显示。list
separator分类间的分隔符号。只有在 style 不是 list 时有用。,
depth要显示的分类层级。0 显示所有层级的分类;-10 很类似,但是显示不分层级;1 只显示第一层的分类。0
class分类列表的 class 名称。category
transform改变分类名称显示方法的函数
suffix为链接添加前缀None

用例:

<%- list_categories(post.categories, {
class: 'post-category',
transform(str) {
return titlecase(str);
}
}) %>
<%- list_categories(post.categories, {
class: 'post-category',
transform(str) {
return str.toUpperCase();
}
}) %>

list_tags

插入标签列表。

<%- 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改变标签名称显示方法的函数。请查看 list_categories 中给出的例子
amount要显示的标签数量(0 = 无限制)0
suffix为链接添加前缀None

list_archives

插入归档列表。

<%- list_archives([options]) %>
参数描述默认值
type类型。此设定可为 yearlymonthlymonthly
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_categories 中给出的例子

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改变文章名称显示方法的函数。请查看 list_categories 中给出的例子

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

其他

paginator

插入分页链接。

<%- 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_sizemid_size 就没用了。false
escapeEscape HTML tagstrue

Examples:

<%- paginator({
prev_text: '<',
next_text: '>'
}) %>
<!-- Rendered as -->
<a href="/1/">&lt;</a>
<a href="/1/">1</a>
2
<a href="/3/">3</a>
<a href="/3/">&gt;</a>
<%- paginator({
prev_text: '<i class="fa fa-angle-left"></i>',
next_text: '<i class="fa fa-angle-right"></i>',
escape: false
}) %>
<!-- Rendered as -->
<a href="/1/"><i class="fa fa-angle-left"></i></a>
<a href="/1/">1</a>
2
<a href="/3/">3</a>
<a href="/3/"><i class="fa fa-angle-right"></i></a>

search_form

插入 Google 搜索框。

<%- search_form(options) %>
参数描述默认值
class表单的 class namesearch-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

meta_generator

Inserts generator tag.

<%- meta_generator() %>

Examples:

<%- meta_generator() %>
// <meta name="generator" content="Hexo 4.0.0">

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:description)内容摘要或前 200 字
twitter_cardTwitter 卡片类型 (twitter:card)summary
twitter_idTwitter ID (twitter:creator)
twitter_siteTwitter 网站 (twitter:site)
google_plusGoogle+ 个人资料链接
fb_adminsFacebook 管理者 ID
fb_app_idFacebook 应用程序 ID

toc

解析内容中的标题标签 (h1~h6) 并插入目录。

<%- toc(str, [options]) %>
参数描述默认值
classClass 名称toc
list_number显示编号true
max_depth生成 TOC 的最大深度6
min_depth生成 TOC 的最小深度1

示例:

<%- toc(page.content) %>