Skip to content

Commit f088866

Browse files
authored
docs: made some improvements on readme. (#110)
1 parent 0148050 commit f088866

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,32 @@ It generates an archive of posts on your homepage, according to the `index` or `
1010

1111
## Installation
1212

13-
``` bash
14-
$ npm install hexo-generator-index --save
13+
```bash
14+
npm install hexo-generator-index --save
1515
```
1616

1717
## Options
1818

19-
Add or modify the following section to your root _config.yml file
19+
Add or modify the following section to your root `_config.yml` file.
2020

21-
``` yaml
21+
```yaml
2222
index_generator:
23-
path: ''
23+
path: ""
2424
per_page: 10
2525
order_by: -date
2626
pagination_dir: page
2727
```
2828
29-
- **path**: Root path for your blog's index page.
30-
- default: ""
29+
- **path**: Root path for your blog's index page.
30+
- default: `""`
3131
- **per_page**: Posts displayed per page.
3232
- default: [`config.per_page`](https://hexo.io/docs/configuration.html#Pagination) as specified in the official Hexo docs (if present), otherwise `10`
33-
- `0` disables pagination
34-
- **order_by**: Posts order.
35-
- default: date descending
33+
- `0` disables pagination.
34+
- **order_by**: Posts order.
35+
- default: `-date` (date descending)
3636
- **pagination_dir**: URL format.
37-
- default: 'page'
38-
- `awesome-page` makes the URL ends with 'awesome-page/<page number>' for second page and beyond.
37+
- default: `page`
38+
- e.g. set `awesome-page` makes the URL ends with `awesome-page/<page number>` for second page and beyond.
3939

4040
## Usage
4141

0 commit comments

Comments
 (0)