Front Matter

Front-matter is a block of YAML or JSON at the beginning of the file that is used to configure settings for your writings. Front-matter is terminated by three dashes when written in YAML or three semicolons when written in JSON.
— from Hexo site.


title: Hello World
date: 2013/7/13 20:46:25


"title": "Hello World",
"date": "2013/7/13 20:46:25"

Next extends and provide more variables. It allows users to configure a single page.

Settings & Their Default Values

Setting Type Description Default
author string Author name for post copyright author in Hexo _config.yml
post_link string Post link None
description string Docs here None
direction string Available value: rtl None
header boolean Whether to display the post header in index page true
mathjax boolean MathJax support math.every_page in _config.yml
sidebar boolean Whether the sidebar will be shown Depends on sidebar.display in _config.yml
copyright boolean Whether to display copyright notices below the post with theme.creative_commons.license and theme.creative_commons.post enabled true
sticky number Pin the post to the top of the index page. hexo-generator-index plugin required 0
quicklink object (1) Quicklink support From _config.yml
reward_settings object (1) Reward settings From _config.yml
toc object (1) Table of Contents in the sidebar From _config.yml

(1): They have the same structure as the options in theme config file.


enable: true
number: false
max_depth: 3
enable: true
comment: Buy me a coffee
enable: true
delay: true
timeout: 3000
priority: true

Undocumented Front-matter Variables

The following variables are not mentioned in the Hexo documentation, but are required by hexo-theme-unit-test.

Setting Type Example
link string link-post
photos array gallery-post