Skip to content

Commit

Permalink
chore: update output parameter docs for DIYgod/RSSHub#15258
Browse files Browse the repository at this point in the history
  • Loading branch information
TonyRL committed Apr 17, 2024
1 parent 8e06237 commit 52c4c96
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions src/guide/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,15 +131,15 @@ There are more details in the [FAQ](/guide/faq).

## Output Formats

RSSHub conforms to RSS 2.0, Atom, JSON Feed and RSS3 UMS Standard. To obtain the feed in a specific format, simply add the `format` parameter with the value `rss`, `atom`, `json`, or `ums` to the feed address to obtain the feed in corresponding format. The default output format is RSS 2.0.
RSSHub conforms to RSS 2.0, Atom, JSON Feed, and RSS3 Protocol. To obtain the feed in a specific format, simply add the `format` parameter with the value `rss`, `atom`, `json`, or `rss3` to the feed address to obtain the feed in the corresponding format. The default output format is RSS 2.0.

E.g.

- Default (RSS 2.0) - [https://rsshub.app/dribbble/popular](https://rsshub.app/dribbble/popular)
- RSS 2.0 - [https://rsshub.app/dribbble/popular?format=rss](https://rsshub.app/dribbble/popular?format=rss)
- Atom - [https://rsshub.app/dribbble/popular?format=atom](https://rsshub.app/dribbble/popular?format=atom)
- JSON Feed - [https://rsshub.app/twitter/user/DIYgod?format=json](https://rsshub.app/twitter/user/DIYgod?format=json)
- RSS3 UMS - [https://rsshub.app/abc?format=ums](https://rsshub.app/abc?format=ums)
- RSS3 - [https://rsshub.app/abc?format=rss3](https://rsshub.app/abc?format=rss3)
- Apply filters or URL query - [https://rsshub.app/dribbble/popular?format=atom&filterout=Blue|Yellow|Black](https://rsshub.app/dribbble/popular?format=atom&filterout=Blue|Yellow|Black)

### debug.json
Expand Down
4 changes: 2 additions & 2 deletions src/zh/guide/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,15 +132,15 @@ Telegram 即时预览模式需要在官网制作页面处理模板,请前往[

## 输出格式

RSSHub 同时支持 RSS 2.0、Atom、JSON Feed 和 RSS3 UMS 输出格式,在路由添加 `format` 参数(值为`rss``atom``json``ums`)即可请求对应输出格式,缺省为 RSS 2.0
RSSHub 同时支持 RSS 2.0、Atom、JSON Feed 和 RSS3 输出格式,在路由添加 `format` 参数(值为`rss``atom``json``rss3`)即可请求对应输出格式,缺省为 RSS 2.0

举例:

- 缺省 RSS 2.0 - [https://rsshub.app/jianshu/home](https://rsshub.app/jianshu/home)
- RSS 2.0 - [https://rsshub.app/jianshu/home?format=rss](https://rsshub.app/jianshu/home?format=rss)
- Atom - [https://rsshub.app/jianshu/home?format=atom](https://rsshub.app/jianshu/home?format=atom)
- JSON Feed - [https://rsshub.app/twitter/user/DIYgod?format=json](https://rsshub.app/twitter/user/DIYgod?format=json)
- RSS3 UMS - [https://rsshub.app/abc?format=ums](https://rsshub.app/abc?format=ums)
- RSS3 - [https://rsshub.app/abc?format=rss3](https://rsshub.app/abc?format=rss3)
- 和 filter 或其他 URL query 一起使用 - `https://rsshub.app/bilibili/user/coin/2267573?format=atom&filter=微小微|赤九玖|暴走大事件`

### debug.json
Expand Down

0 comments on commit 52c4c96

Please sign in to comment.