Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: made some improvements on readme. #110

Merged
merged 1 commit into from
Jul 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,32 @@ It generates an archive of posts on your homepage, according to the `index` or `

## Installation

``` bash
$ npm install hexo-generator-index --save
```bash
npm install hexo-generator-index --save
```

## Options

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

``` yaml
```yaml
index_generator:
path: ''
path: ""
per_page: 10
order_by: -date
pagination_dir: page
```

- **path**: Root path for your blog's index page.
- default: ""
- **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
- `0` disables pagination.
- **order_by**: Posts order.
- default: `-date` (date descending)
- **pagination_dir**: URL format.
- default: 'page'
- `awesome-page` makes the URL ends with 'awesome-page/<page number>' for second page and beyond.
- default: `page`
- e.g. set `awesome-page` makes the URL ends with `awesome-page/<page number>` for second page and beyond.

## Usage

Expand Down
Loading