Skip to content

Commit

Permalink
Merge pull request #47 from daiyitastic/daiyi/update-readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
lzjqsdd authored Dec 2, 2016
2 parents f1977f8 + cdca00c commit 19ab397
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 @@ -13,6 +13,10 @@ $ npm install hexo-generator-feed --save
- Hexo 3: 1.x
- Hexo 2: 0.x

## Use

In the [front-matter](https://hexo.io/docs/front-matter.html) of your post, you can optionally add a `description` setting to write a summary for the post. Otherwise the summary will default to the excerpt or the first 140 characters of the post.

## Options

You can configure this plugin in `_config.yml`.
Expand All @@ -23,9 +27,11 @@ feed:
path: atom.xml
limit: 20
hub:
content:
```
- **type** - Feed type. (atom/rss2)
- **path** - Feed path. (Default: atom.xml/rss2.xml)
- **limit** - Maximum number of posts in the feed (Use `0` or `false` to show all posts)
- **hub** - URL of the PubSubHubbub hubs (Leave it empty if you don't use it)
- **content** - (optional) set to 'true' to include the contents of the entire post in the feed.

0 comments on commit 19ab397

Please sign in to comment.