Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stevenjoezhang/hexo-generator-indexed
Index generator plugin for Hexo.
https://github.com/stevenjoezhang/hexo-generator-indexed
hexo hexo-plugin hide-articles
Last synced: 21 days ago
JSON representation
Index generator plugin for Hexo.
- Host: GitHub
- URL: https://github.com/stevenjoezhang/hexo-generator-indexed
- Owner: next-theme
- License: mit
- Created: 2019-06-19T04:05:54.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T23:22:53.000Z (3 months ago)
- Last Synced: 2024-10-30T01:51:25.226Z (3 months ago)
- Topics: hexo, hexo-plugin, hide-articles
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/hexo-generator-indexed
- Size: 99.6 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hexo-generator-indexed
[![npm-image]][npm-url]
[![lic-image]](LICENSE)
Index generator for [Hexo].
It generates an archive of posts on your homepage, according to the `index` or `archive` layout of your theme.
## Installation
![size-image]
[![dm-image]][npm-url]
[![dt-image]][npm-url]
``` bash
$ npm install hexo-generator-indexed
```
## Options
Add or modify the following section to your root _config.yml file
``` yaml
index_generator:
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`](https://hexo.io/docs/configuration.html#Pagination) 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.
## Note
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](https://github.com/hexojs/hexo-generator-archive) to generate an archive according to the `archive` layout.
## Feature & Usage
### 置顶文章 Pinned article
**这一功能已被加入 `hexo-generator-index`。**
**This feature is now part of `hexo-generator-index`.**
在文章的 [Front-matter](https://hexo.io/docs/front-matter) 中增加一个 `sticky` 参数用来置顶，其值应为大于0的整数，表示置顶的优先级（未指定则默认为 0）。数字越大，文章越靠前。
Add a `sticky` parameter to the the post's [Front-matter](https://hexo.io/docs/front-matter) to make the post pinned at the top of home page.
```markdown
---
title: example
sticky: 100
---
```
采用 `sticky` 关键词是因为这个在 [NexT 主题](https://github.com/next-theme/hexo-theme-next)中已经定义了置顶样式，因此可以直接拿来使用。
### 隐藏文章 Hide article
在文章的 Front-matter 中增加一个 `hide` 参数用来隐藏。
Add a `hide` parameter to the the post's Front-matter to hide the post from home page.
```markdown
---
title: example
hide: true
---
```
### 隐藏特定分类中的文章 Hide articles in specified categories
在 Hexo 的 `_config.yml` 中可以通过 `hide_categories` 选项设置隐藏某个分类下的文章，例如：
You can hide articles in specified categories by setting `hide_categories` in hexo `_config.yml`, e.g.
```yml
hide_categories:
- category1
- category2
```
## License
MIT
[Hexo]: http://hexo.io/
[npm-image]: https://img.shields.io/npm/v/hexo-generator-indexed?style=flat-square
[lic-image]: https://img.shields.io/npm/l/hexo-generator-indexed?style=flat-square
[size-image]: https://img.shields.io/github/languages/code-size/next-theme/hexo-generator-indexed?style=flat-square
[dm-image]: https://img.shields.io/npm/dm/hexo-generator-indexed?style=flat-square
[dt-image]: https://img.shields.io/npm/dt/hexo-generator-indexed?style=flat-square
[npm-url]: https://www.npmjs.com/package/hexo-generator-indexed