Returns a url with the root path prefixed. You should use this helper instead of config.root + path since Hexo 2.7.
<%- url_for(path) %>
relative_url
Returns the relative URL from from to to.
<%- relative_url(from, to) %>
gravatar
Inserts a Gravatar image. If you didn’t specify the [options] parameter, the default options will apply. Otherwise, you can set it to a number which will then be passed on as the size parameter to Gravatar. Finally, if you set it to an object, it will be converted into a query string of parameters for Gravatar.
Loads CSS files. path can be an array or a string. If path isn’t prefixed with / or any protocol, it’ll get prefixed with the root URL. If you didn’t add the .css extension after path, it will be added automatically.
Loads JavaScript files. path can be an array or a string. If path isn’t prefixed with / or any protocol, it’ll get prefixed with the root URL. If you didn’t add the .js extension after path, it will be added automatically.
Inserts formatted date and time. date can be unix time, ISO string, date object, or Moment.js object. format is date_format + time_format setting by default.
<%- full_date(date, [format]) %>
Examples:
<%- 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
Sort of order. 1, asc for ascending; -1, desc for descending
1
show_count
Display the number of posts for each category
true
style
Style to display the category list. list displays categories in an unordered list.
list
separator
Separator between categories. (Only works if style is not list)
,
depth
Levels of categories to be displayed. 0 displays all categories and child categories; -1 is similar to 0 but displayed in flat; 1 displays only top level categories.
0
class
Class name of category list.
category
transform
The function that changes the display of category name.
Sort of order. 1, asc for ascending; -1, desc for descending
1
show_count
Display the number of posts for each tag
true
style
Style to display the tag list. list displays tags in an unordered list.
list
separator
Separator between categories. (Only works if style is not list)
,
class
Class name of tag list.
tag
transform
The function that changes the display of tag name. See examples in list_categories.
amount
The number of tags to display (0 = unlimited)
0
suffix
Add a suffix to link.
None
list_archives
Inserts a list of archives.
<%- list_archives([options]) %>
Option
Description
Default
type
Type. This value can be yearly or monthly.
monthly
order
Sort of order. 1, asc for ascending; -1, desc for descending
1
show_count
Display the number of posts for each archive
true
format
Date format
MMMM YYYY
style
Style to display the archive list. list displays archives in an unordered list.
list
separator
Separator between archives. (Only works if style is not list)
,
class
Class name of archive list.
archive
transform
The function that changes the display of archive name. See examples in list_categories.
list_posts
Inserts a list of posts.
<%- list_posts([options]) %>
Option
Description
Default
orderby
Order of posts
date
order
Sort of order. 1, asc for ascending; -1, desc for descending
1
style
Style to display the post list. list displays posts in an unordered list.
list
separator
Separator between posts. (Only works if style is not list)
,
class
Class name of post list.
post
amount
The number of posts to display (0 = unlimited)
6
transform
The function that changes the display of post name. See examples in list_categories.
tagcloud
Inserts a tag cloud.
<%- tagcloud([tags], [options]) %>
Option
Description
Default
min_font
Minimum font size
10
max_font
Maximum font size
20
unit
Unit of font size
px
amount
Total amount of tags
unlimited
orderby
Order of tags
name
order
Sort order. 1, asc as ascending; -1, desc as descending
1
color
Colorizes the tag cloud
false
start_color
Start color. You can use hex (#b700ff), rgba (rgba(183, 0, 255, 1)), hsla (hsla(283, 100%, 50%, 1)) or color keywords. This option only works when color is true.
end_color
End color. You can use hex (#b700ff), rgba (rgba(183, 0, 255, 1)), hsla (hsla(283, 100%, 50%, 1)) or color keywords. This option only works when color is true.
Examples:
// Default options <%- tagcloud() %>
// Limit number of tags to 30 <%- tagcloud({amount: 30}) %>
Miscellaneous
paginator
Inserts a paginator.
<%- paginator(options) %>
Option
Description
Default
base
Base URL
/
format
URL format
page/%d/
total
The number of pages
1
current
Current page number
0
prev_text
The link text of previous page. Works only if prev_next is set to true.
Prev
next_text
The link text of next page. Works only if prev_next is set to true.
Next
space
The space text
&hellp;
prev_next
Display previous and next links
true
end_size
The number of pages displayed on the start and the end side
1
mid_size
The number of pages displayed between current page, but not including current page
2
show_all
Display all pages. If this is set to true, end_size and mid_size will not work.
false
search_form
Inserts a Google search form.
<%- search_form(options) %>
Option
Description
Default
class
The class name of form
search-form
text
Search hint word
Search
button
Display search button. The value can be a boolean or a string. If the value is a string, it’ll be the text of the button.
false
number_format
Formats a number.
<%- number_format(number, [options]) %>
Option
Description
Default
precision
The precision of number. The value can be false or a nonnegative integer.
false
delimiter
The thousands delimiter
,
separator
The separator between the fractional and integer digits.