Skip to content

Commit

Permalink
Merge pull request #40 from curbengh/readme
Browse files Browse the repository at this point in the history
docs: clarify purpose of plugin
  • Loading branch information
curbengh authored Sep 8, 2019
2 parents 7623757 + 54582ab commit 31a46aa
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

Index generator for [Hexo].

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

## Installation

``` bash
Expand Down Expand Up @@ -33,6 +35,10 @@ index_generator:
- default: 'page'
- `awesome-page` makes the URL ends with 'awesome-page/<page number>' 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.

## License

MIT
Expand Down

0 comments on commit 31a46aa

Please sign in to comment.