辅助函数（Helpers）

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

网址

url_for

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

<%- url_for(path) %>

relative_url

取得与 from 相对的 to 路径。

<%- relative_url(from, to) %>

gravatar

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

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

示例：

<%- gravatar('[email protected]'
// http://www.gravatar.com/avatar/b9b00e66c6b8a70f88c73cb6bdb06787
<%- gravatar('[email protected]'40
// http://www.gravatar.com/avatar/b9b00e66c6b8a70f88c73cb6bdb06787?s=40
<%- gravatar('[email protected]'40'http://example.com/image.png'
// http://www.gravatar.com/avatar/b9b00e66c6b8a70f88c73cb6bdb06787?s=40&d=http%3A%2F%2Fexample.com%2Fimage.png

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

示例：

<%- 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'true
// <a href="http://www.google.com" title="Google" target="_blank" rel="external">Google</a>

mail_to

插入电子邮箱链接。

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

示例：

<%- mail_to('[email protected]'
// <a href="mailto:[email protected]" title="[email protected]">[email protected]</a>
<%- mail_to('[email protected]''Email'
// <a href="mailto:[email protected]" title="Email">Email</a>

image_tag

插入图片。

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

favicon_tag

插入 favicon。

<%- favicon_tag(path) %>

feed_tag

插入 feed 链接。

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

条件函数

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_categoryhobby

is_tag

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

<%- is_tag() %><%-is_taghobby

字符串处理

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

使每行的字符串长度不超过 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'17
// Once upon a ti...
<%- truncate('Once upon a time in a world far far away'17' '
// Once upon a...
<%- truncate('And they found that many people were sleeping better.'25'... (continued)'
// And they f... (continued)

模板

partial

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

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

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
// 2013-01-01
<%- date(Date'YYYY/M/D'
// Jan 1 2013

date_xml

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

<%- date_xml(date) %>

示例：

<%- date_xml(Date
// 2013-01-01T00:00:00.000Z

time

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

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

示例：

<%- time(Date
// 13:05:12
<%- time(Date'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(newDate
// Jan 1, 2013 0:00:00
<%- full_date(newDate'dddd, MMMM Do YYYY, h:mm:ss a'
// Tuesday, January 1st 2013, 12:00:00 am

moment

Moment.js 函数库。

列表

list_categories

插入分类列表。

<%- list_categories([options]) %>

list_tags

插入标签列表。

<%- list_tags([options]) %>

list_archives

插入归档列表。

<%- list_archives([options]) %>

list_posts

插入文章列表。

<%- list_posts([options]) %>

tagcloud

插入标签云。

<%- tagcloud([tags], [options]) %>

其他

paginator

插入分页链接。

<%- paginator(options) %>

search_form

插入 Google 搜索框。

<%- search_form(options) %>

number_format

格式化数字。

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

示例：

<%- number_format(12345.671
// 12,345.68
<%- number_format(12345.674
// 12,345.6700
<%- number_format(12345.670
// 12,345
<%- number_format(12345.67''
// 12345.67
<%- number_format(12345.67'/'
// 12,345/67

open_graph

插入 open graph 资源。

<%- open_graph([options]) %>

toc

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

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

示例：

<%- toc(page.content) %>