Hexo 輔助函數(shù)

輔助函數(shù)幫助您在模版中快速插入內(nèi)容。輔助函數(shù)不能在源文件中使用。

網(wǎng)址

url_for

在路徑前加上根路徑，從 Hexo 2.7 開始您應(yīng)該使用此函數(shù)而不是 config.root + path。

<%- url_for(path, [option]) %>

示例：

_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 參數(shù)禁用相對鏈接輸出，反之亦然
 */
<%- 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

根據(jù)郵箱地址返回 Gravatar 頭像 URL。

如果你不指定 options 參數(shù)，將會應(yīng)用默認參數(shù)。否則，你可以將其設(shè)置為一個數(shù)字，這個數(shù)字將會作為 Gravatar 的大小參數(shù)。最后，如果你設(shè)置它一個對象，它將會被轉(zhuǎn)換為 Gravatar 的一個查詢字符串參數(shù)。

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

訪問 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

在路徑前加上根路徑和域名。輸出會被自動轉(zhuǎn)碼。

<%- 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 可以是數(shù)組或字符串，如果 path 開頭不是 / 或任何協(xié)議，則會自動加上根路徑；如果后面沒有加上 .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 可以是數(shù)組或字符串，如果 path 開頭不是 / 或任何協(xié)議，則會自動加上根路徑；如果后面沒有加上 .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]) %>

示例：

<%- link_to('http://www.google.com') %>
// <a  rel="external nofollow" target="_blank"  rel="external nofollow" target="_blank"  rel="external nofollow" target="_blank"  title="http://www.google.com">http://www.google.com</a>

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

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

mail_to

插入電子郵箱鏈接。

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

示例：

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

favicon_tag

插入 favicon。

<%- favicon_tag(path) %>

feed_tag

插入 feed 鏈接。

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

示例：

<%- feed_tag('atom.xml') %>
// <link rel="alternate" href="/atom.xml" title="Hexo" type="application/atom+xml">

<%- feed_tag('rss.xml', { title: 'RSS Feed', type: 'rss' }) %>
// <link rel="alternate" href="/atom.xml" title="RSS Feed" type="application/rss+xml">

/* Defaults to hexo-generator-feed's config if no argument */
<%- feed_tag() %>
// <link rel="alternate" href="/atom.xml" title="Hexo" type="application/atom+xml">

條件函數(shù)

is_current

檢查 path 是否符合目前頁面的網(wǎng)址。開啟 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

檢查當前頁面是否為分類歸檔頁面。
如果給定一個字符串作為參數(shù)，將會檢查目前是否為指定分類。

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

is_tag

檢查當前頁面是否為標簽歸檔頁面。
如果給定一個字符串作為參數(shù)，將會檢查目前是否為指定標簽。

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

字符串處理

trim

清除字符串開頭和結(jié)尾的空格。

<%- trim(string) %> 

strip_html

清除字符串中的 HTML 標簽。

<%- strip_html(string) %>

示例：

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

titlecase

把字符串轉(zhuǎn)換為正確的 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]) %>

Examples:

<%- render('p(class="example") Test', 'pug'); %>
// <p class="example">Test</p>

See Rendering for more details.

word_wrap

使每行的字符串長度不超過 length。length 預(yù)設(shè)為 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 設(shè)定區(qū)域變量。

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

fragment_cache

局部緩存。它儲存局部內(nèi)容，下次使用時就能直接使用緩存。

<%- 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 函數(shù)庫。

列表

list_categories

插入分類列表。

<%- list_categories([options]) %>

用例:

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

Class advanced customization:

Examples:

<%- list_tags(site.tags, {class: 'classtest', style: false, separator: ' | '}) %>
<%- list_tags(site.tags, {class: 'classtest', style: 'list'}) %>
<%- list_tags(site.tags, {class: {ul: 'ululul', li: 'lilili', a: 'aaa', count: 'ccc'}, style: false, separator: ' | '}) %>
<%- list_tags(site.tags, {class: {ul: 'ululul', li: 'lilili', a: 'aaa', count: 'ccc'}, style: 'list'}) %>

list_archives

插入歸檔列表。

<%- list_archives([options]) %>

list_posts

插入文章列表。

<%- list_posts([options]) %>

tagcloud

插入標簽云。

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

其他

paginator

插入分頁鏈接。

<%- paginator(options) %>

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/">></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) %>

number_format

格式化數(shù)字。

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

示例：

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

toc

解析內(nèi)容中的標題標簽 (h1~h6) 并插入目錄。

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

示例：

<%- toc(page.content) %>