標籤外掛(Tag Plugins)

標籤外掛和 Front-matter 中的標籤不同,它們是用於在文章中快速插入特定內容的外掛。

雖然你可以以任何格式寫你的文章,但標籤外掛會永遠可用,且語法都會相同。

標籤外掛不應該被包裝在 Markdown 語法當中,例如: []({% post_path lorem-ipsum %}) 是不支援的。

引用區塊 (Block Quote)

在文章中插入引言,可包含作者、來源和標題。

捷徑: quote

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

沒有提供參數,僅輸出普通的引用區塊

{% 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.

引用書上的句子

{% 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

引用 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

引用網路上的文章

{% 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.

程式碼區塊 (Code Block)

在文章中插入程式碼。

捷徑: code

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

option:value 格式設定額外的選項,例如:line_number:false first_line:5

額外選項 說明 預設值
line_number 顯示行號 true
line_threshold 當程式碼區塊的行數超過臨界值時,才顯示行號。 0
highlight 啟用程式碼強調 true
first_line 設定起始的程式碼行號 1
mark 強調特定的程式碼行號,每個值會以逗點區分。特定的程式碼區間則使用破折號 (dash)
範例:mark:1,4-7,10 會標示行號 1、 4 到 7 以及 10。
wrap 將程式碼區塊包裝在 <table> true

普通的程式碼區塊

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

指定語言

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

加上說明

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

加上說明和網址

{% 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) 程式碼區塊

另一種形式的程式碼區塊。

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

抬升式引用區塊 (Pull Quote)

在文章中插入抬升式引用區塊。

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

jsFiddle (v7.0.0 中刪除)

如果你使用 v7.0.0+,請使用 hexo-tag-embed 作為替代。

在文章中嵌入 jsFiddle。

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

Gist (v7.0.0 中刪除)

如果你使用 v7.0.0+,請使用 hexo-tag-embed 作為替代。

在文章中嵌入 Gist。

{% gist gist_id [filename] %}

iframe

在文章中插入 iframe。

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

圖片

在文章中插入指定大小的圖片。

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

連結

在文章中插入連結,並在外部連結自動加上 target="_blank" 屬性。

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

插入程式碼

插入 source/downloads/code 資料夾內的程式檔,資料夾取決於你在設定文件中 code_dir 的設定。

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

Youtube (v7.0.0 中刪除)

如果你使用 v7.0.0+,請使用 hexo-tag-embed 作為替代。

在文章中插入 Youtube 影片。

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

範例

影片

{% youtube lJIrF4YjHfQ %}

播放列表

{% youtube PL9hW1uS6HUfscJ9DHkOSoOX45MjXduUxo 'playlist' %}

隱私模式

禁止 YouTube cookie

{% youtube lJIrF4YjHfQ false %}
{% youtube PL9hW1uS6HUfscJ9DHkOSoOX45MjXduUxo 'playlist' false %}

Vimeo (v7.0.0 中刪除)

如果你使用 v7.0.0+,請使用 hexo-tag-embed 作為替代。

在文章中插入 Vimeo 影片。

{% vimeo video_id %}

引用文章

引用其他文章的連結。

{% post_path filename %}
{% post_link filename [title] [escape] %}

當你使用這個標籤時,你可以忽略永久連結 (permalink) 以及資料夾資訊,如語言及日期。

例如:{% post_link how-to-bake-a-cake %}

只要文章的檔案名稱是 how-to-bake-a-cake.md,甚至文章位於 source/posts/2015-02-my-family-holiday 或是具有永久連結 2018/en/how-to-bake-a-cake 時都會運作。

你可以自定義要顯示的文字,取代顯示文章的標題。

文章標題及自定義文字預設會逸出 (escape)。你可以使用選項 escape 將逸出關閉。

例如:

顯示文章標題。

{% post_link hexo-3-8-released %}

Hexo 3.8.0 Released

顯示自訂文字。

{% post_link hexo-3-8-released 'Link to a post' %}

Link to a post

逸出標題。

{% post_link hexo-4-released 'How to use <b> tag in title' %}
How to use <b> tag in title

不要逸出標題。

{% post_link hexo-4-released '<b>bold</b> custom title' false %}
bold custom title

引用資產

引用文章的資產。

{% asset_path filename %}
{% asset_img [class names] slug [width] [height] [title text [alt text]] %}
{% asset_link filename [title] [escape] %}

嵌入圖片

hexo-renderer-marked 3.1.0+ 可以(可選的)自動解析文章內的圖片路徑,請參考這個區塊了解如何啟用它。

“foo.jpg” 位於 http://example.com/2020/01/02/hello/foo.jpg

預設(沒有選項)

{% asset_img foo.jpg %}

<img src="/2020/01/02/hello/foo.jpg">

自訂 Class

{% asset_img post-image foo.jpg %}

<img src="/2020/01/02/hello/foo.jpg" class="post-image">

顯示尺寸

{% asset_img foo.jpg 500 400 %}

<img src="/2020/01/02/hello/foo.jpg" width="500" height="400">

標題及替代文字

{% asset_img logo.svg "lorem ipsum'dolor'" %}

<img src="/2020/01/02/hello/foo.jpg" title="lorem ipsum" alt="dolor">

URL

url_for (7.0.0+)

回傳一個具有前綴根路徑 URL。輸出將會自動編碼。

{% url_for text path [relative] %}

範例:

_config.yml
root: /blog/ # 範例
{% url_for blog index.html %}
<a href="/blog/index.html">blog</a>

相對路徑連結則預設依照選項 relative_link
例如:post/page 路徑是 ‘/foo/bar/index.html’

_config.yml
relative_link: true
{% url_for blog index.html %}
<a href="../../index.html">blog</a>

relative_link 啟用時,你也可以關閉使其輸出一個非相對路徑連結,反之亦然。

{% url_for blog index.html false %}
<a href="/index.html">blog</a>

full_url_for (7.0.0+)

回傳一個 config.url 前綴的 URL。輸出將會自動編碼。

{% full_url_for text path %}

範例:

_config.yml
url: https://example.com/blog # 範例
{% full_url_for index /a/path %}
<a href="https://example.com/blog/a/path">index</a>

Raw

如果您要在文章中插入 Swig 標籤,可以試著使用 Raw 標籤,以免發生解析異常。

{% raw %}
content
{% endraw %}

文章摘要

使用在 <!-- more --> 標籤之前的文字作為為這篇文章的摘要。front-matter 中的 excerpt: 值如果被特指的話,將會將其優先使用。

範例:

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.