Hexo Built-in Tag Helpers

The following content is taken from Hexo documentation with minor revisions.

Tag plugins are different from post tags. They are ported from Octopress and provide a useful way for you to quickly add specific content to your posts.

Since Hexo 7, the jsfiddle, gist, youtube, and vimeo tags are no longer built into Hexo. They are provided by the hexo-tag-embed plugin, which you need to install in your site (npm install hexo-tag-embed) before using them.

Block Quote

Perfect for adding quotes to your post, with optional author, source and title information.

Alias: quote

{% blockquote [author[, source]] [link] [source_link_title] %}
content
{% endblockquote %}

Examples

No arguments. Plain blockquote.

{% blockquote %}
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque hendrerit lacus ut purus iaculis feugiat. Sed nec tempor elit, quis aliquam neque. Curabitur sed diam eget dolor fermentum semper at eu lorem.
{% endblockquote %}

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque hendrerit lacus ut purus iaculis feugiat. Sed nec tempor elit, quis aliquam neque. Curabitur sed diam eget dolor fermentum semper at eu lorem.

Quote from a book

{% blockquote David Levithan, Wide Awake %}
Do not just seek happiness for yourself. Seek happiness for all. Through kindness. Through mercy.
{% endblockquote %}

Do not just seek happiness for yourself. Seek happiness for all. Through kindness. Through mercy.

David LevithanWide Awake

Quote from Twitter

{% blockquote @DevDocs https://twitter.com/devdocs/status/356095192085962752 %}
NEW: DevDocs now comes with syntax highlighting. http://devdocs.io
{% endblockquote %}

NEW: DevDocs now comes with syntax highlighting. http://devdocs.io

@DevDocstwitter.com/devdocs/status/356095192085962752

Quote from an article on the web

{% blockquote Seth Godin http://sethgodin.typepad.com/seths_blog/2009/07/welcome-to-island-marketing.html Welcome to Island Marketing %}
Every interaction is both precious and an opportunity to delight.
{% endblockquote %}

Every interaction is both precious and an opportunity to delight.

Seth GodinWelcome to Island Marketing

Code Block

Useful feature for adding code snippets to your post.

Alias: code

{% codeblock [title] [lang:language] [url] [link text] %}
code snippet
{% endcodeblock %}

Examples

A plain code block

{% codeblock %}
alert('Hello World!');
{% endcodeblock %}

alert('Hello World!');

Specifying the language

{% codeblock lang:objc %}
[rectangle setX: 10 y: 10 width: 20 height: 20];
{% endcodeblock %}

[rectangle setX: 10 y: 10 width: 20 height: 20];

Adding a caption to the code block

{% codeblock Array.map %}
array.map(callback[, thisArg])
{% endcodeblock %}

Array.map

array.map(callback[, thisArg])

Adding a caption and a URL

{% codeblock _.compact http://underscorejs.org/#compact Underscore.js %}
_.compact([0, 1, false, 2, '', 3]);
=> [1, 2, 3]
{% endcodeblock %}

_.compactUnderscore.js

_.compact([0, 1, false, 2, '', 3]);
=> [1, 2, 3]

Backtick Code Block

This is identical to using a code block, but instead uses three backticks to delimit the block.

``` [language] [title] [url] [link text]
code snippet
```

Pull Quote

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi semper auctor nulla, a mollis nibh congue luctus. Mauris sagittis dui sit amet scelerisque gravida. Proin porttitor convallis libero.

To add pull quotes to your posts:

{% pullquote [CSS class] %}
content
{% endpullquote %}

jsFiddle

To embed a jsFiddle snippet (requires hexo-tag-embed):

{% jsfiddle shorttag [tabs] [skin] [width] [height] %}

Gist

To embed a Gist snippet (requires hexo-tag-embed):

{% gist gist_id [filename] %}

iframe

To embed an iframe:

{% iframe url [width] [height] %}

Image

Inserts an image with specified size.

{% img [class names] /path/to/image [width] [height] [title text [alt text]] %}

Link

Inserts a link with target="_blank" attribute.

{% link text url [external] [title] %}

Hexo.io

Include Code

Inserts code snippets in source/downloads/code folder.

{% include_code [title] [lang:language] path/to/file %}

Exampleview raw

// source/downloads/code/example.js, inserted with the include_code tag
function greet(name) {
    return `Hello, ${name}!`;
}

console.log(greet('Icarus'));

YouTube

Inserts a YouTube video or playlist (requires hexo-tag-embed). Set type to playlist to embed a playlist, and cookie to false to use the privacy-enhanced mode of YouTube.

{% youtube video_id [type] [cookie] %}

Vimeo

Inserts a Vimeo video (requires hexo-tag-embed).

{% vimeo video_id [width] [height] %}

Include Posts

Include links to other posts.

{% post_path slug %}
{% post_link slug [title] %}

Include Assets

Include post assets.

{% asset_path slug %}
{% asset_img slug [title] %}
{% asset_link slug [title] %}

URL

Inserts a link to a path of your site. url_for adds the root of your site to the path, and full_url_for adds the url of your site instead.

{% url_for text path [relative] %}
{% full_url_for text path %}

{% url_for "The archives page" /archives/ %}

The archives page

Raw

If certain content is causing processing issues in your posts, wrap it with the raw tag to avoid rendering errors.

{% raw %}
content
{% endraw %}

Post Excerpt

Use text placed before the <!-- more --> tag as an excerpt for the post.

Examples:

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
<!-- more -->
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.