Helpers

Os Helpers são usados em templates para ajudá-lo a inserir snippets (trechos de código) rapidamente. Os helpers não podem ser usados em arquivos de source (arquivos de postagem em Markdown por exemplo).

Você pode usar os helpers padrões do Hexo ou criar seus próprios helpers personalizados.

URL

url_for

Retorna uma url com o caminho raiz prefixado. Você deve usar esse helper em vez de config.root + path desde a versão 2.7 do Hexo.

<%- url_for(path) %>

relative_url

Retorna a URL relativa de from para to.

<%- relative_url(from, to) %>

gravatar

Insere uma imagem do Gravatar.
Se você não especificar o parâmetro [options], as opções padrão serão aplicadas. Caso contrário, você pode configurá-lo para um número que será passado como parâmetro de tamanho para o Gravatar. Finalmente, se você configurá-lo para um objeto, ele será convertido em uma string de consulta de parâmetros para o Gravatar.

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

Exemplos:

<%- gravatar('[email protected]') %>
// http://www.gravatar.com/avatar/b9b00e66c6b8a70f88c73cb6bdb06787

<%- gravatar('[email protected]', 40) %>
// http://www.gravatar.com/avatar/b9b00e66c6b8a70f88c73cb6bdb06787?s=40

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

HTML Tags

css

Carrega arquivos CSS. Onde path pode ser um array ou uma string. Se path não for prefixado com / ou com qualquer protocolo, ele será prefixado com a URL raiz. Se você não adicionar a extensão .css após path, ela será adicionada automaticamente.

<%- css(path, ...) %>

Exemplos:

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

Carrega arquivos JavaScript. O path pode ser uma array ou uma string. Se path não for prefixado com / ou com qualquer protocolo, ele será prefixado com a URL raiz. Se você não adicionar a extensão .js após path, ela será adicionada automaticamente.

<%- js(path, ...) %>

Exemplos:

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

Insere um link.

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

Opção	Descrição	Padrão
`external`	Abre o link em uma nova aba	false
`class`	Nome da classe
`id`	ID

Exemplos:

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

mail_to

Insere um link de e-mail.

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

Opção	Descrição
`class`	Nome da classe
`id`	ID
`subject`	Assunto do e-mail
`cc`	CC
`bcc`	BCC
`body`	Conteúdo do e-mail

Exemplos:

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

Insere uma imagem.

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

Opção	Descrição
`alt`	Texto alternativo da imagem
`class`	Nome da classe
`id`	ID
`width`	Largura da imagem
`height`	Altura da imagem

favicon_tag

Insere um favicon.

<%- favicon_tag(path) %>

feed_tag

Insere um link de feed.

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

Opção	Descrição	Padrão
`title`	Título do feed
`type`	Tipo do feed	atom

Tags condicionais

is_current

Verifica se path corresponde à URL da página atual. Use opções strict para habilitar um modo estrito de correspondência.

<%- is_current(path, [strict]) %>

is_home

Verifica se a página atual é a pagina home.

<%- is_home() %>

is_post

Verifica se a página atual é uma postagem.

<%- is_post() %>

is_archive

Verifica se a página atual é uma página de arquivo.

<%- is_archive() %>

is_year

Verifica se a página atual é uma página de arquivo anual.

<%- is_year() %>

is_month

Verifica se a página atual é uma página de arquivo mensal.

<%- is_month() %>

is_category

Verifica se a página atual é uma página de categoria.
Se uma string for dada como parâmetro, também é verificado se a página atual corresponde à categoria dada.

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

is_tag

Verifica se a página atual é uma página de tag.
Se uma string for dada como parâmetro, também é verificado se a página atual corresponde à tag fornecida.

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

Manipulação de String

trim

Remove espaços em branco no inicio e fim de uma string.

<%- trim(string) %>

strip_html

Remove as tags HTML de uma string.

<%- strip_html(string) %>

Exemplo:

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

titlecase

Formata um título com as primeiras letras de palavras importantes em maiúsculo.

<%- titlecase(string) %>

Exemplos:

<%- titlecase('this is an apple') %>
# This is an Apple

markdown

Renderiza um conteúdo em Markdown.

<%- markdown(str) %>

Exemplos:

<%- markdown('make me **strong**') %>
// make me <strong>strong</strong>

render

Renderiza uma string.

<%- render(str, engine, [options]) %>

word_wrap

Coloca uma quebra de linha no texto a partir de um limite de caracteres, o limite é length. Por padrão, o valor de length é 80.

<%- word_wrap(str, [length]) %>

Exemplos:

<%- word_wrap('Once upon a time', 8) %>
// Once upon\n a time

truncate

Omite o texto após um certo valor de length. O valor padrão de length é 30 caracteres.

<%- truncate(text, [options]) %>

Examples:

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

Templates

partial

Carrega outros arquivos de template. Você pode definir variáveis locais em locals.

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

Opção	Descrição	Padrão
`cache`	Conteúdo da cache (usa fragmento de cache)	`false`
`only`	Variáveis locais estritas. Só usa variáveis definidas em `locals` dentro de templates.	`false`

fragment_cache

Cache do conteúdo em um fragmento. Salva o conteúdo dentro de um fragmento e serve o cache quando a próxima requisição chegar.

<%- fragment_cache(id, fn);

Exemplos:

<%- fragment_cache('header', function(){
  return '<header></header>';
}) %>

Date & Time

date

Insere a data formatada. date pode ser data no padrão Unix, string ISO, objeto de data ou objeto Moment.js. A Opção format usa a definição date_format por padrão.

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

Exemplos:

<%- date(Date.now()) %>
// 2013-01-01

<%- date(Date.now(), 'YYYY/M/D') %>
// Jan 1 2013

date_xml

Insere a data no formato XML. date pode ser data no padrão Unix, string ISO, objeto de data ou objeto Moment.js.

<%- date_xml(date) %>

Exemplos:

<%- date_xml(Date.now()) %>
// 2013-01-01T00:00:00.000Z

time

Insere a hora formatada. date pode ser data no padrão Unix, string ISO, objeto de data ou objeto Moment.js. A Opção format usa a definição time_format por padrão.

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

Exemplo:

<%- time(Date.now()) %>
// 13:05:12

<%- time(Date.now(), 'h:mm:ss a') %>
// 1:05:12 pm

full_date

Insere a data e a hora formatadas. date pode ser data no padrão Unix, string ISO, objeto de data ou objeto Moment.js. A Opção format usa a definição date_format + time_format por padrão.

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

Exemplos:

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

Biblioteca Moment.js.

List

Insere uma lista de todas as categorias.

<%- list_categories([options]) %>

Opção	Descrição	Padrão
`orderby`	Critério de ordenação das categorias	name
`order`	Tipo de ordenação. `1`, `asc` para ascendente; `-1`, `desc` para descendente	1
`show_count`	Exibir o número de postagens para cada categoria	true
`style`	Estilo para exibir a lista de categorias. `list` exibe as categorias em uma lista não ordenada.	list
`separator`	Separador entre categorias. (Só funciona se `style` não for `list`).	,
`depth`	Níveis de categorias a serem exibidos. `0` exibe todas as categorias e suas categorias filhas; `-1` é semelhante a `0`, mas exibe as categorias e suas filhas em um mesmo nível hierárquico; `1` exibe apenas as categorias de nível superior.	0
`class`	Nome da classe da lista de categorias.	category
`transform`	A função que altera a exibição do nome da categoria.
`suffix`	Adiciona um sufixo para o link.	None

Insere uma lista de tags.

<%- list_tags([options]) %>

Opção	Descrição	Padrão
`orderby`	Critério de ordenação das tags	name
`order`	Tipo de ordem. `1`, `asc` para ascendente; `-1`, `desc` para descendente	1
`show_count`	Exibir o número de postagens para cada tag	true
`style`	Estilo para exibir a lista de tags. `list` exibe as tags em uma lista não ordenada.	list
`separator`	Separador entre tags. (Só funciona se `style` não for `list`).	,
`class`	Nome da classe da lista de tags.	tag
`transform`	A função que altera a exibição do nome da tag.
`amount`	O número de tags a exibir (0 = ilimitado)	0
`suffix`	Adiciona um sufixo para o link.	Nenhum

list_archives

Insere uma lista de arquivos (archives).

<%- list_archives([options]) %>

Opção	Descrição	Padrão
`type`	Tipo. Esse valor pode ser `yearly` ou `monthly`.	monthly
`order`	Tipo de ordem. `1`, `asc` para ascendente; `-1`, `desc` para descendente	1
`show_count`	Exibir o número de postagens para cada arquivo	true
`format`	Formato da data	MMMM YYYY
`style`	Estilo para exibir a lista de arquivos. `list` exibe arquivos em uma lista não ordenada.	list
`separator`	Separador entre arquivos. (Só funciona se `style` não for `list`)	,
`class`	Nome da classe da lista de arquivos.	archive
`transform`	A função que altera a exibição do nome do archive.

list_posts

Insere uma lista de posts.

<%- list_posts([options]) %>

Opção	Descrição	Padrão
`orderby`	Critério de ordenação de postagens	date
`order`	Tipo de ordem. `1`, `asc` para ascendente; `-1`, `desc` para descendente	1
`style`	Estilo para exibir a lista de postagens. `list` exibe as postagens em uma lista não ordenada.	list
`separator`	Separador entre postagens. (Só funciona se `style` não for `list`)	,
`class`	Nome da classe da lista de postagem.	post
`amount`	O número de postagens a serem exibidas (0 = ilimitado)	6
`transform`	A função que altera a exibição do nome do post.

Insere uma nuvem de tags.

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

Opção	Descrição	Padrão
`min_font`	Tamanho mínimo da fonte	10
`max_font`	Tamanho máximo da fonte	20
`unit`	Unidade de tamanho de fonte	px
`amount`	Quantidade total de tags	40
`orderby`	Critério de ordenação de tags	name
`order`	Tipo de ordem. `1`, `asc` para ascendente; `-1`, `desc` para descendente	1
`color`	Colorizar a nuvem de tags?	false
`start_color`	Cor inicial. Você pode usar o padrão hexadecimal (`#b700ff`), rgba (`rgba(183, 0, 255, 1)`), hsla (`hsla(283, 100%, 50%, 1)`) ou color keywords. Esta opção só funciona quando `color` é `true`.
`end_color`	Cor final. Você pode usar o padrão hexadecimal (`#b700ff`), rgba (`rgba(183, 0, 255, 1)`), hsla (`hsla(283, 100%, 50%, 1)`) ou color keywords. Esta opção só funciona quando `color` é `true`.

Miscelânea

paginator

Insere um paginador.

<%- paginator(options) %>

Opção	Descrição	Padrão
`base`	URL base	/
`format`	Formato da URL	page/%d/
`total`	Número de páginas	1
`current`	Número da página atual	0
`prev_text`	O texto do link da página anterior. Funciona apenas se `prev_next` estiver definido como `true`.	Prev
`next_text`	O texto do link da próxima página. Funciona apenas se `prev_next` estiver definido como `true`.	Next
`space`	Espaço do texto	&hellp;
`prev_next`	Exibir os links anteriores e seguintes	true
`end_size`	O número de páginas exibidas no início e no final	1
`mid_size`	O número de páginas exibidas entre a página atual, mas não incluindo a página atual	2
`show_all`	Exibir todas as páginas. Se isso for definido como `true`, `end_size` e`mid_size` não irão funcionar.	false

Insere o formulário de busca do Google.

<%- search_form(options) %>

Opção	Descrição	Padrão
`class`	O nome da classe do formulário	search-form
`text`	Palavra de sugestão de busca	Search
`button`	Exibir o botão de busca. O valor pode ser um booleano ou uma string. Quando o valor é uma string, ele será o texto do botão.	false

number_format

Formata um número.

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

Opção	Descrição	Padrão
`precision`	A precisão do número. O valor pode ser `false` ou um número inteiro não negativo.	false
`delimiter`	O delimitador de casa de milhares	,
`separator`	O separador entre os dígitos fracionários e inteiros.	.

Exemplos:

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

open_graph

Insere dados do Open Graph.

<%- open_graph([options]) %>

Opção	Descrição	Padrão
`title`	Título da página (`og:title`)	`page.title`
`type`	Tipo de página (`og:type`)	blog
`url`	URL da página (`og:url`)	`url`
`image`	Capa da página (`og:image`)	Primeira imagem no conteúdo
`site_name`	Nome do site (`og:site_name`)	`config.title`
`description`	Descrição da página (`og:desription`)	Trecho da página ou os 200 primeiros caracteres do conteúdo
`twitter_card`	Tipo de Twitter card (`twitter:card`)	summary
`twitter_id`	Twitter ID (`twitter:creator`)
`twitter_site`	Site do Twitter (`twitter:site`)
`google_plus`	Link de perfil do Google+
`fb_admins`	ID de administrador do Facebook
`fb_app_id`	ID da aplicação do Facebook

Opção	Descrição	Padrão
`class`	Nome da classe	toc
`list_number`	Exibe o número da lista	true
`max_depth`	Profundidade máxima do cabeçalho gerado	6