Files
RSSHub/docs/parameter.md
2019-03-25 19:10:55 +08:00

63 lines
1.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 通用参数
::: tip 提示
所有通用参数可以使用 `&` 连接组合使用, 效果叠加
:::
## 内容过滤
可以使用以下 URL query 过滤内容, 支持正则
filter 选出想要的内容
- filter: 过滤标题和描述
- filter_title: 过滤标题
- filter_description: 过滤描述
- filter_author: 过滤作者
举例: <https://rsshub.app/bilibili/user/coin/2267573?filter=微小微|赤九玖|暴走大事件>
filterout 去掉不要的内容
- filterout: 过滤标题和描述
- filterout_title: 过滤标题
- filterout_description: 过滤描述
- filterout_author: 过滤作者
举例: <https://rsshub.app/bilibili/user/coin/2267573?filterout=微小微|赤九玖|暴走大事件>
## 条数限制
可以使用 limit 参数限制最大条数, 主要用于排行榜类 RSS
举例: bilibili 排行榜前 10 <https://rsshub.app/bilibili/ranking/0/3?limit=10>
## 输出 Telegram 即时预览链接
可以输出 Telegram 可识别的即时预览链接, 主要用于文章类 RSS
Telegram 即时预览模式需要在官网制作页面处理模板,请前往[官网](https://instantview.telegram.org/)了解更多
- tgiv: 模板 hash可从模板制作页面分享出来的链接末尾获取`&rhash=`后面跟着的字符串)
举例: <https://rsshub.app/novel/biquge/94_94525?tgiv=bd3c42818a7f7e>
## 输出格式
RSSHub 同时支持 RSS 2.0 和 Atom 输出格式, 在路由末尾添加 `.rss``.atom` 即可请求对应输出格式, 缺省为 RSS 2.0
举例:
- 缺省 RSS 2.0 - <https://rsshub.app/jianshu/home>
- RSS 2.0 - <https://rsshub.app/jianshu/home.rss>
- Atom - <https://rsshub.app/jianshu/home.atom>
- 和 filter 或其他 URL query 一起使用 <https://rsshub.app/bilibili/user/coin/2267573.atom?filter=微小微|赤九玖|暴走大事件>