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

authorstringAuthor name for post copyrightauthor in Hexo _config.yml
post_linkstringPost linkNone
descriptionstringDocs hereNone
directionstringAvailable value: rtlNone
headerbooleanWhether to display the post header in index pagetrue
mathjaxbooleanMathJax supportmath.every_page in _config.yml
sidebarbooleanWhether the sidebar will be shownDepends on sidebar.display in _config.yml
copyrightbooleanWhether to display copyright notices below the post with theme.creative_commons.license and enabledtrue
stickynumberPin the post to the top of the index page. hexo-generator-index plugin required0
quicklinkobject (1)Quicklink supportFrom _config.yml
reward_settingsobject (1)Reward settingsFrom _config.yml
tocobject (1)Table of Contents in the sidebarFrom _config.yml

(1): They have the same structure as the options in NexT 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.