hexo-generator-exindex v1.0.3

hexo-generator-exindex

Extenp hexo-generator-index to provide topping and hiding specified articles on the homepage through specified tags.

Installation

npm install hexo-generator-exindex --save
npm uninstall hexo-generator-index --save

Hint: If you have install hexo-generator-index, for avoiding conflict, you should unintall it.

Feature

• include all of hexo-generator-index feat
• Pin-top
• pin-bottom
• exclude

Config

The following is an example of a complete configuration.

exindex_generator_enable: true
exindex_generator:
  path: ''
  per_page: 10
  order_by: -date
  pagination_dir: page
  pin_top:
    tags: topping1,topping2
  pin_bottom:
    tags: bottoming1,bottoming2
  exclude:
    tags: hidden1,hidden2

pin-top

Setting front-matter tags which you set in root _config.yml like that:

---
title: Isaac Blog
tags:
  - topping1
date: 2023-04-11 18:19:51
---

pin-bottom

---
title: Isaac Blog
tags:
  - bottoming1
date: 2023-04-11 18:19:51
---

Hint: When pin-top and pin-bottom appear simultaneously, the latter has a higher priority.

exclude

---
title: Isaac Blog
tags:
  - hidden1
date: 2023-04-11 18:19:51
---

Options

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

exindex_generator_enable: true
exindex_generator:
  path: ''
  per_page: 10
  order_by: -date
  pagination_dir: page
  pin_top:
    tags: topping
  pin_bottom:
    tags: bottoming # exclude article which tag is Hexo, exp tags: <tag1>[,<tag2>,...]

• exindex_generator_enable: on or off this plugins.
• 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.
• pin_top: Bring the article to the top.
  • default: ""
  • tags: <tag1>[,<tag2>,...], you need to set these tags at fron-matter!
• pin_bottom: Bring the article to the bottom.
  • default: ""
  • tags: <tag1>[,<tag2>,...]
• exclude: Hide corresponding articles through tags.
  • default: ""
  • tags: <tag1>[,<tag2>,...]

License

MIT @ isaaxite