Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including hexo-generator-index with all npm packages installed. Try it out:

var hexoGeneratorIndex = require("hexo-generator-index")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

hexo-generator-index v2.0.0

Index generator for Hexo.


Build Status NPM version Coverage Status

Index generator for Hexo.

It generates an archive of posts on your homepage, according to the index or archive layout of your theme.


$ npm install hexo-generator-index --save


Add or modify the following section to your root _config.yml file

  path: ''
  per_page: 10
  order_by: -date
  pagination_dir: page
  • path: Root path for your blog's index page.
    • default: ""
  • per_page: Posts displayed per page.
    • default: config.per_page as specified in the official Hexo docs (if present), otherwise 10
    • 0 disables pagination
  • order_by: Posts order.
    • default: date descending
  • pagination_dir: URL format.
    • default: 'page'
    • awesome-page makes the URL ends with 'awesome-page/' for second page and beyond.


The sticky parameter in the post Front-matter will be used to pin the post to the top of the index page. Higher sticky means that it will be ranked first.

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


If your theme define a non-archive index layout (e.g. About Me page), this plugin would follow that layout instead and not generate an archive. In that case, use hexo-generator-archive to generate an archive according to the archive layout.



RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free