diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index f949980063..f6190eb10b 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,37 +1,85 @@ module.exports = { - title: 'RSSHub', - description: '🍰 万物皆可 RSS', ga: 'UA-48084758-10', serviceWorker: true, + locales: { + '/': { + lang: 'zh-CN', + title: 'RSSHub', + description: '🍰 万物皆可 RSS', + }, + '/en/': { + lang: 'en-US', + title: 'RSSHub', + description: '🍰 万物皆可 RSS', + }, + }, themeConfig: { repo: 'DIYgod/RSSHub', editLinks: true, - editLinkText: '在 GitHub 上编辑此页', - lastUpdated: '上次更新', - serviceWorker: { - updatePopup: { - message: '发现新内容可用', - buttonText: '刷新', + docsDir: 'docs', + locales: { + '/': { + lang: 'zh-CN', + selectText: '选择语言', + label: '简体中文', + editLinkText: '在 GitHub 上编辑此页', + lastUpdated: '上次更新', + serviceWorker: { + updatePopup: { + message: '发现新内容可用', + buttonText: '刷新', + }, + }, + nav: [ + { + text: '使用', + link: '/', + }, + { + text: '参与我们', + link: '/joinus/', + }, + { + text: '部署', + link: '/install/', + }, + { + text: '支持 RSSHub', + link: '/support/', + }, + ], + }, + '/en/': { + lang: 'en-US', + selectText: 'Languages', + label: 'English', + editLinkText: 'Edit this page on GitHub', + lastUpdated: 'Last Updated', + serviceWorker: { + updatePopup: { + message: 'New content is available', + buttonText: 'Refresh', + }, + }, + nav: [ + { + text: 'Use', + link: '/en/', + }, + { + text: 'Join us', + link: '/en/joinus/', + }, + { + text: 'Deploy', + link: '/en/install/', + }, + { + text: 'Support RSSHub', + link: '/en/support/', + }, + ], }, }, - docsDir: 'docs', - nav: [ - { - text: '使用', - link: '/', - }, - { - text: '参与我们', - link: '/joinus/', - }, - { - text: '部署', - link: '/install/', - }, - { - text: '支持 RSSHub', - link: '/support/', - }, - ], }, }; diff --git a/docs/en/README.md b/docs/en/README.md new file mode 100644 index 0000000000..62a4762dd1 --- /dev/null +++ b/docs/en/README.md @@ -0,0 +1,1802 @@ +--- +sidebar: auto +--- + +

+RSSHub +

+

RSSHub

+ +RSSHub 是一个轻量、易于扩展的 RSS 生成器，可以给任何奇奇怪怪的内容生成 RSS 订阅源 + +## 鸣谢 + +### Special Sponsors + +

+ + + +

+

+ + + +

+ +### Sponsors + +- [Liuyang](https://github.com/lingllting) + +- [Zuyang](https://zuyang.farbox.com) + +- [Sayori Studio](https://t.me/SayoriStudio) + +[![](https://opencollective.com/static/images/become_sponsor.svg)](https://docs.rsshub.app/support/) + +### Contributors + +[![](https://opencollective.com/RSSHub/contributors.svg?width=890)](https://github.com/DIYgod/RSSHub/graphs/contributors) + +::: tip 提示 + +演示地址为 [rsshub.app](https://rsshub.app)，缓存时间 10 分钟，可以随意使用 + +::: + +## 通用参数 + +::: tip 提示 + +所有通用参数可以组合使用，效果叠加 + +::: + +### 内容过滤 + +可以使用以下 URL query 过滤内容，支持正则 + +filter 选出想要的内容 + +- filter: 过滤标题和描述 + +- filter_title: 过滤标题 + +- filter_description: 过滤描述 + +举例: [https://rsshub.app/bilibili/user/coin/2267573?filter=微小微|赤九玖|暴走大事件](https://rsshub.app/bilibili/user/coin/2267573?filter=微小微|赤九玖|暴走大事件) + +filterout 去掉不要的内容 + +- filterout: 过滤标题和描述 + +- filterout_title: 过滤标题 + +- filterout_description: 过滤描述 + +举例: [https://rsshub.app/bilibili/user/coin/2267573?filterout=微小微|赤九玖|暴走大事件](https://rsshub.app/bilibili/user/coin/2267573?filterout=微小微|赤九玖|暴走大事件) + +### 条数限制 + +可以使用 limit 参数限制最大条数，主要用于排行榜类 RSS + +举例：bilibili 排行榜前 10 [https://rsshub.app/bilibili/ranking/0/3?limit=10](https://rsshub.app/bilibili/ranking/0/3?limit=10) + +### 输出格式 + +RSSHub 同时支持 RSS 2.0、Atom 和 [JSON Feed](https://jsonfeed.org/) 输出格式，在路由末尾添加 `.rss` `.atom` 或 `.json` 即可请求对应输出格式，缺省为 RSS 2.0 + +举例: + +- 缺省 RSS 2.0 - [https://rsshub.app/jianshu/home](https://rsshub.app/jianshu/home) +- RSS 2.0 - [https://rsshub.app/jianshu/home.rss](https://rsshub.app/jianshu/home.rss) +- Atom - [https://rsshub.app/jianshu/home.atom](https://rsshub.app/jianshu/home.atom) +- JSON Feed - [https://rsshub.app/jianshu/home.json](https://rsshub.app/jianshu/home.json) +- 和 filter 或其他 URL query 一起使用 [https://rsshub.app/bilibili/user/coin/2267573.atom?filter=微小微|赤九玖|暴走大事件](https://rsshub.app/bilibili/user/coin/2267573.atom?filter=微小微|赤九玖|暴走大事件) + +## 程序更新 + +### RSSHub + +举例: [https://rsshub.app/rsshub/rss](https://rsshub.app/rsshub/rss) + +路由: `/rsshub/rss` + +参数: 无 + +### MIUI + +举例: [https://rsshub.app/miui/aries/](https://rsshub.app/miui/aries/) + +路由: `/miui/:device/:type?` + +参数 + +device: 设备的 `codename` 例如 小米 2s 为 `aries` + +type: 类型，可选参数 + +| 稳定版 | 开发版 | +| ------- | ------ | +| release | dev | + +### Firefox + +举例: [https://rsshub.app/firefox/release/desktop](https://rsshub.app/firefox/release/desktop) + +路由: `/firefox/release/:platform` + +参数: platform + +| 桌面 | Android | Beta | Nightly | Android Beta | +| ------- | ------- | ---- | ------- | ------------ | +| dekstop | android | beta | nightly | android-beta | + +### 腾讯云移动直播 SDK + +举例: [https://rsshub.app/qcloud/mlvb/changelog](https://rsshub.app/qcloud/mlvb/changelog) + +路由: `/qcloud/mlvb/changelog` + +参数：无 + +### Bugly SDK + +举例: [https://rsshub.app/bugly/changelog/1](https://rsshub.app/bugly/changelog/1) + +路由: `/bugly/changelog/:platform` + +参数：platform, 平台类型，必选，1 为 Android，2 为 iOS + +## bilibili + +### 番剧 + +举例: [https://rsshub.app/bilibili/bangumi/21680](https://rsshub.app/bilibili/bangumi/21680) + +路由: `/bilibili/bangumi/:seasonid` + +参数: seasonid，番剧 id，番剧主页打开控制台执行 `window.__INITIAL_STATE__.ssId` 或 `window.__INITIAL_STATE__.mediaInfo.param.season_id` 获取 + +### UP 主投稿 + +举例: [https://rsshub.app/bilibili/user/video/2267573](https://rsshub.app/bilibili/user/video/2267573) + +路由: `/bilibili/user/video/:uid` + +参数: uid，用户 id，可在 UP 主主页中找到 + +### UP 主动态 + +举例: [https://rsshub.app/bilibili/user/dynamic/2267573](https://rsshub.app/bilibili/user/dynamic/2267573) + +路由: `/bilibili/user/dynamic/:uid` + +参数: uid，用户 id，可在 UP 主主页中找到 + +### UP 主频道 + +举例: [https://rsshub.app/bilibili/channel/142821407/23390](https://rsshub.app/bilibili/channel/142821407/23390) + +路由: `/bilibili/channel/:uid/:cid` + +参数: uid，用户 id，可在 UP 主主页中找到 + +cid，频道 ID,可在频道的 URL 中找到 + +### UP 主默认收藏夹 + +举例: [https://rsshub.app/bilibili/user/fav/2267573](https://rsshub.app/bilibili/user/fav/2267573) + +路由: `/bilibili/user/fav/:uid` + +参数: uid，用户 id，可在 UP 主主页中找到 + +### UP 主非默认收藏夹 + +举例: [https://rsshub.app/bilibili/fav/756508/50948568](https://rsshub.app/bilibili/fav/756508/50948568) + +路由: `/bilibili/fav/:uid/:fid` + +参数: uid，用户 id，可在 UP 主主页中找到 + +fid，收藏夹 ID,可在收藏夹的 URL 中找到,默认收藏夹建议使用 UP 主默认收藏夹功能 + +### UP 主投币视频 + +举例: [https://rsshub.app/bilibili/user/coin/2267573](https://rsshub.app/bilibili/user/coin/2267573) + +路由: `/bilibili/user/coin/:uid` + +参数: uid，用户 id，可在 UP 主主页中找到 + +### UP 主粉丝 + +举例: [https://rsshub.app/bilibili/user/followers/2267573](https://rsshub.app/bilibili/user/followers/2267573) + +路由: `/bilibili/user/followers/:uid` + +参数: uid，用户 id，可在 UP 主主页中找到 + +### UP 主关注用户 + +举例: [https://rsshub.app/bilibili/user/followings/2267573](https://rsshub.app/bilibili/user/followings/2267573) + +路由: `/bilibili/user/followings/:uid` + +参数: uid，用户 id，可在 UP 主主页中找到 + +### 分区视频 + +举例: [https://rsshub.app/bilibili/partion/33](https://rsshub.app/bilibili/partion/33) + +路由: `/bilibili/partion/:tid` + +参数: tid，分区 id + +动画 + +| MAD·AMV | MMD·3D | 短片·手书·配音 | 综合 | +| ------- | ------ | -------------- | ---- | +| 24 | 25 | 47 | 27 | + +番剧 + +| 连载动画 | 完结动画 | 资讯 | 官方延伸 | +| -------- | -------- | ---- | -------- | +| 33 | 32 | 51 | 152 | + +国创 + +| 国产动画 | 国产原创相关 | 布袋戏 | 资讯 | +| -------- | ------------ | ------ | ---- | +| 153 | 168 | 169 | 170 | + +音乐 + +| 原创音乐 | 翻唱 | VOCALOID·UTAU | 演奏 | 三次元音乐 | OP/ED/OST | 音乐选集 | +| -------- | ---- | ------------- | ---- | ---------- | --------- | -------- | +| 28 | 31 | 30 | 59 | 29 | 54 | 130 | + +舞蹈 + +| 宅舞 | 三次元舞蹈 | 舞蹈教程 | +| ---- | ---------- | -------- | +| 20 | 154 | 156 | + +游戏 + +| 单机游戏 | 电子竞技 | 手机游戏 | 网络游戏 | 桌游棋牌 | GMV | 音游 | Mugen | +| -------- | -------- | -------- | -------- | -------- | --- | ---- | ----- | +| 17 | 171 | 172 | 65 | 173 | 121 | 136 | 19 | + +科技 + +| 趣味科普人文 | 野生技术协会 | 演讲·公开课 | 星海 | 数码 | 机械 | 汽车 | +| ------------ | ------------ | ----------- | ---- | ---- | ---- | ---- | +| 124 | 122 | 39 | 96 | 95 | 98 | 176 | + +生活 + +| 搞笑 | 日常 | 美食圈 | 动物圈 | 手工 | 绘画 | ASMR | 运动 | 其他 | +| ---- | ---- | ------ | ------ | ---- | ---- | ---- | ---- | ---- | +| 138 | 21 | 76 | 75 | 161 | 162 | 175 | 163 | 174 | + +鬼畜 + +| 鬼畜调教 | 音 MAD | 人力 VOCALOID | 教程演示 | +| -------- | ------ | ------------- | -------- | +| 22 | 26 | 126 | 127 | + +时尚 + +| 美妆 | 服饰 | 健身 | 资讯 | +| ---- | ---- | ---- | ---- | +| 157 | 158 | 164 | 159 | + +广告 + +| 广告 | +| ---- | +| 166 | + +娱乐 + +| 综艺 | 明星 | Korea 相关 | +| ---- | ---- | ---------- | +| 71 | 137 | 131 | + +影视 + +| 影视杂谈 | 影视剪辑 | 短片 | 预告·资讯 | 特摄 | +| -------- | -------- | ---- | --------- | ---- | +| 182 | 183 | 85 | 184 | 86 | + +纪录片 + +| 全部 | 人文·历史 | 科学·探索·自然 | 军事 | 社会·美食·旅行 | +| ---- | --------- | -------------- | ---- | -------------- | +| 177 | 37 | 178 | 179 | 180 | + +电影 + +| 全部 | 华语电影 | 欧美电影 | 日本电影 | 其他国家 | +| ---- | -------- | -------- | -------- | -------- | +| 23 | 147 | 145 | 146 | 83 | + +电视剧 + +| 全部 | 国产剧 | 海外剧 | +| ---- | ------ | ------ | +| 11 | 185 | 187 | + +### 视频评论 + +举例: [https://rsshub.app/bilibili/video/reply/21669336](https://rsshub.app/bilibili/video/reply/21669336) + +路由: `/bilibili/video/reply/:aid` + +参数: aid，可在视频页 URL 中找到 + +### link 公告 + +举例: [https://rsshub.app/bilibili/link/news/live](https://rsshub.app/bilibili/link/news/live) + +路由: `/bilibili/link/news/:product` + +参数: product, 公告分类 包括 直播:live 小视频:vc 相簿:wh + +### 直播开播 + +举例: [https://rsshub.app/bilibili/live/room/3](https://rsshub.app/bilibili/live/room/3) + +路由: `bilibili/live/room/:roomID` + +参数: roomID, 房间号 可在直播间 URL 中找到,长短号均可 + +### 直播搜索 + +举例: [https://rsshub.app/bilibili/live/search/编程/online](https://rsshub.app/bilibili/live/search/编程/online) + +路由: `bilibili/live/search/:key/:order` + +参数 + +key: 搜索关键字 + +order: 排序方式，live_time 开播时间，online 人气 + +### 直播分区 + +::: warning 注意 + +由于接口未提供开播时间，如果直播间未更换标题与分区，将视为一次。如果直播间更换分区与标题，将视为另一项 + +::: + +举例: [https://rsshub.app/bilibili/live/area/143/online](https://rsshub.app/bilibili/live/area/143/online) + +路由: `bilibili/live/area/:areaID/:order` + +参数 + +areaID: 分区 ID 分区增删较多，可通过 [分区列表](https://api.live.bilibili.com/room/v1/Area/getList) 查询 + +order: 排序方式，live_time 开播时间，online 人气 + +### 主站话题列表 + +举例: [https://rsshub.app/bilibili/blackboard](https://rsshub.app/bilibili/blackboard) + +路由: `bilibili/blackboard` + +### 会员购新品上架 + +举例: [https://rsshub.app/bilibili/mall/new](https://rsshub.app/bilibili/mall/new) + +路由: `bilibili/mall/new` + +### 会员购作品 + +举例: [https://rsshub.app/bilibili/mall/ip/1_4494](https://rsshub.app/bilibili/mall/ip/1_4494) + +路由: `/bilibili/mall/ip/:id` + +参数: id, 作品 id, 可在作品列表页 URL 中找到 + +### 排行榜 + +举例: [https://rsshub.app/bilibili/ranking/0/3](https://rsshub.app/bilibili/ranking/0/3) + +路由: `/bilibili/ranking/:rid?/:day?` + +参数: + +day: 时间跨度，可为 1 3 7 30 + +rid: 排行榜分区 id，默认 0 + +| 全站 | 动画 | 国创相关 | 音乐 | 舞蹈 | 游戏 | 科技 | 生活 | 鬼畜 | 时尚 | 娱乐 | 影视 | +| ---- | ---- | -------- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | +| 0 | 1 | 168 | 3 | 129 | 4 | 36 | 160 | 119 | 155 | 5 | 181 | + +## bangumi + +### 放送列表 + +举例: [https://rsshub.app/bangumi/calendar/today](https://rsshub.app/bangumi/calendar/today) + +路由: `/bangumi/calendar/today` + +参数: 无 + +## 微博 + +### 博主 + +举例: [https://rsshub.app/weibo/user/3306934123](https://rsshub.app/weibo/user/3306934123) + +路由: `/weibo/user/:uid` + +参数: uid，用户 id，博主主页打开控制台执行 `/uid=(\d+)/. exec(document.querySelector('.opt_box .btn_bed').getAttribute('action-data'))[1]` 获取 + +::: warning 注意 + +上述方案获取 V+ 付费博主会有数据缺失，所以这里提供另外一种方式，这种方式的缺点是描述不如上面的完善，建议优先选择第一种方案 + +::: + +举例: [https://rsshub.app/weibo/user2/3306934123](https://rsshub.app/weibo/user2/3306934123) + +路由: `/weibo/user2/:uid` + +### 关键词 + +举例: [https://rsshub.app/weibo/keyword/DIYgod](https://rsshub.app/weibo/keyword/DIYgod) + +路由: `/weibo/keyword/:keyword` + +参数: keyword，你想订阅的微博关键词 + +## 贴吧 + +### 帖子列表 + +举例: [https://rsshub.app/tieba/forum/女图](https://rsshub.app/tieba/forum/女图) + +路由: `/tieba/forum/:kw` + +参数: `kw`，吧名 + +### 精品帖子 + +举例: [https://rsshub.app/tieba/forum/good/女图](https://rsshub.app/tieba/forum/good/女图) + +路由: `/tieba/forum/good/:kw/:cid?` + +参数： + +`kw`: 吧名 + +`cid`: 精品分类，如果不传 `cid` 则获取全部分类 + +## 即刻 + +### 主题-精选 + +举例: [https://rsshub.app/jike/topic/54dffb40e4b0f57466e675f0](https://rsshub.app/jike/topic/54dffb40e4b0f57466e675f0) + +路由: `/jike/topic/:id` + +参数: id，主题 id，可在即刻 web 端主题页或 APP 分享出来的主题页 URL 中找到 + +### 主题-广场 + +举例: [https://rsshub.app/jike/topic/square/54dffb40e4b0f57466e675f0](https://rsshub.app/jike/topic/square/54dffb40e4b0f57466e675f0) + +路由: `/jike/topic/square/:id` + +参数: id，主题 id，可在即刻 web 端主题页或 APP 分享出来的主题页 URL 中找到 + +### 用户动态 + +举例: [https://rsshub.app/jike/user/82D23B32-CF36-4C59-AD6F-D05E3552CBF3](https://rsshub.app/jike/user/82D23B32-CF36-4C59-AD6F-D05E3552CBF3) + +路由: `/jike/user/:id` + +参数: id，用户 id，可在即刻 web 端用户页 URL 中找到 + +## 微信 + +### 公众号 + +::: tip 提示 + +公众号抓取困难，目前可提供的方案是通过即刻的公众号主题订阅 + +::: + +举例: [https://rsshub.app/jike/topic/584b8ac671a288001154a115](https://rsshub.app/jike/topic/584b8ac671a288001154a115) + +## 网易云音乐 + +### 歌单歌曲 + +举例: [https://rsshub.app/ncm/playlist/35798529](https://rsshub.app/ncm/playlist/35798529) + +路由: `/ncm/playlist/:id` + +参数: id，歌单 id，可在歌单页 URL 中找到 + +### 用户歌单 + +举例: [https://rsshub.app/ncm/user/playlist/45441555](https://rsshub.app/ncm/user/playlist/45441555) + +路由: `/ncm/user/playlist/:uid` + +参数: uid，用户 uid，可在用户主页 URL 中找到 + +### 歌手专辑 + +举例: [https://rsshub.app/ncm/artist/2116](https://rsshub.app/ncm/artist/2116) + +路由: `/ncm/artist/:id` + +参数: id，歌手 id，可在歌手详情页 URL 中找到 + +### 电台节目 + +举例: [https://rsshub.app/ncm/djradio/347317067](https://rsshub.app/ncm/djradio/347317067) + +路由: `/ncm/djradio/:id` + +参数: id, 节目 id, 可在电台节目页 URL 中找到 + +## 掘金 + +### 分类 + +举例: [https://rsshub.app/juejin/category/frontend](https://rsshub.app/juejin/category/frontend) + +路由: `/juejin/category/:category` + +参数: category，分类名 + +| 前端 | Android | iOS | 后端 | 设计 | 产品 | 工具资源 | 阅读 | 人工智能 | +| -------- | ------- | --- | ------- | ------ | ------- | -------- | ------- | -------- | +| frontend | android | ios | backend | design | product | freebie | article | ai | + +## 简书 + +### 首页 + +举例: [https://rsshub.app/jianshu/home](https://rsshub.app/jianshu/home) + +路由: `/jianshu/home` + +参数: 无 + +### 7 日热门 + +举例: [https://rsshub.app/jianshu/trending/weekly](https://rsshub.app/jianshu/trending/weekly) + +路由: `/jianshu/trending/weekly` + +参数: 无 + +### 30 日热门 + +举例: [https://rsshub.app/jianshu/trending/monthly](https://rsshub.app/jianshu/trending/monthly) + +路由: `/jianshu/trending/monthly` + +参数: 无 + +### 专题 + +举例: [https://rsshub.app/jianshu/collection/xYuZYD](https://rsshub.app/jianshu/collection/xYuZYD) + +路由: `/jianshu/collection/:id` + +参数: id，专题 id，可在专题页 URL 中找到 + +### 作者 + +举例: [https://rsshub.app/jianshu/user/yZq3ZV](https://rsshub.app/jianshu/user/yZq3ZV) + +路由: `/jianshu/user/:id` + +参数: id，作者 id，可在作者主页 URL 中找到 + +## 知乎 + +::: warning 注意 + +知乎反爬虫策略非常严格，以下演示经常失效，建议自搭 + +::: + +### 收藏夹 + +举例: [https://rsshub.app/zhihu/collection/26444956](https://rsshub.app/zhihu/collection/26444956) + +路由: `/zhihu/collection/:id` + +参数: id，收藏夹 id，可在收藏夹页面 URL 中找到 + +### 用户动态 + +举例: [https://rsshub.app/zhihu/people/activities/diygod](https://rsshub.app/zhihu/people/activities/diygod) + +路由: `/zhihu/people/activities/:id` + +参数: id，用户 id，可在用户主页 URL 中找到 + +### 用户回答 + +举例: [https://rsshub.app/zhihu/people/answers/diygod](https://rsshub.app/zhihu/people/answers/diygod) + +路由: `/zhihu/people/answers/:id` + +参数: id，用户 id，可在用户主页 URL 中找到 + +### 专栏 + +举例: [https://rsshub.app/zhihu/zhuanlan/googledevelopers](https://rsshub.app/zhihu/zhuanlan/googledevelopers) + +路由: `/zhihu/zhuanlan/:id` + +参数: id，专栏 id，可在专栏主页 URL 中找到 + +### 知乎日报 + +举例：[https://rsshub.app/zhihu/daily](https://rsshub.app/zhihu/daily) + +路由：`/zhihu/daily` + +## 自如 + +### 房源 + +举例: [https://rsshub.app/ziroom/room/sh/1/2/五角场](https://rsshub.app/ziroom/room/sh/1/2/五角场) + +路由: `/ziroom/room/:city/:iswhole/:room/:keyword` + +参数 + +city: 城市，北京 bj；上海 sh；深圳 sz；杭州 hz；南京 nj；广州 gz；成都 cd；武汉 wh；天津 tj + +iswhole: 是否整租 + +room: 房间数 + +keyword: 关键词 + +## 快递 + +::: warning 注意 + +快递送达后请及时取消订阅，以免浪费服务器资源 + +::: + +举例: [https://rsshub.app/express/youzhengguoji/CV054432809US](https://rsshub.app/express/youzhengguoji/CV054432809US) + +路由: `/express/:company/:number` + +参数 + +company: 快递公司代码，参考 [API URL 所支持的快递公司及参数说明](https://www.kuaidi100.com/download/api_kuaidi100_com%2820140729%29.doc) + +number: 快递单号 + +## 妹子图 + +::: warning 注意 + +该网站在国外无法访问，故以下演示无效 + +::: + +### 首页（最新） + +举例: [https://rsshub.app/mzitu](https://rsshub.app/mzitu) + +路由: `/mzitu/` + +### 分类 + +举例: [https://rsshub.app/mzitu/category/hot](https://rsshub.app/mzitu/category/hot) + +路由: `/mzitu/category/:category` + +参数：category，分类名 + +| 热门 | 推荐 | 性感妹子 | 日本妹子 | 台湾妹子 | 清纯妹子 | +| ---- | ---- | -------- | -------- | -------- | -------- | +| hot | best | xinggan | japan | taiwan | mm | + +### 所有专题 + +举例: [https://rsshub.app/mzitu/tags](https://rsshub.app/mzitu/tags) + +路由: `/mzitu/tags` + +### 专题详情 + +举例: [https://rsshub.app/mzitu/tag/shishen](https://rsshub.app/mzitu/tag/shishen) + +路由: `/mzitu/tag/:tag` + +参数: tag，专题名，可在专题页 URL 中找到 + +### 详情 + +举例: [https://rsshub.app/mzitu/post/129452](https://rsshub.app/mzitu/post/129452) + +路由: `/mzitu/post/:id` + +参数: id，详情 id，可在详情页 URL 中找到 + +## pixiv + +### 用户收藏 + +举例: [https://rsshub.app/pixiv/user/bookmarks/15288095](https://rsshub.app/pixiv/user/bookmarks/15288095) + +路由: `/pixiv/user/bookmarks/:id` + +参数: id，用户 id，可在用户主页 URL 中找到 + +### 用户动态 + +举例: [https://rsshub.app/pixiv/user/11](https://rsshub.app/pixiv/user/11) + +路由: `/pixiv/user/:id` + +参数: id，用户 id，可在用户主页 URL 中找到 + +### 排行榜 + +举例: [https://rsshub.app/pixiv/ranking/week](https://rsshub.app/pixiv/ranking/week) + +路由: `/pixiv/ranking/:mode/:date?` + +参数 + +mode: 排行榜类型 + +| pixiv 日排行 | pixiv 周排行 | pixiv 月排行 | pixiv 受男性欢迎排行 | pixiv 受女性欢迎排行 | pixiv 原创作品排行 | pixiv 新人排行 | +| ------------ | ------------ | ------------ | -------------------- | -------------------- | ------------------ | -------------- | +| day | week | month | day_male | day_female | week_original | week_rookie | + +| pixiv R-18 日排行 | pixiv R-18 受男性欢迎排行 | pixiv R-18 受女性欢迎排行 | pixiv R-18 周排行 | pixiv R-18G 排行 | +| ----------------- | ------------------------- | ------------------------- | ----------------- | ---------------- | +| day_r18 | day_male_r18 | day_female_r18 | week_r18 | week_r18g | + +date: 日期，取值形如 `2018-4-25` + +## 豆瓣 + +### 正在上映的电影 + +举例: [https://rsshub.app/douban/movie/playing](https://rsshub.app/douban/movie/playing) + +路由: `/douban/movie/playing` + +参数: 无 + +### 正在上映的高分电影 + +举例: [https://rsshub.app/douban/movie/playing/7.5](https://rsshub.app/douban/movie/playing/7.5) + +路由 + +`/douban/movie/playing/:score` + +`/douban/movie/playing/:score/:city` + +参数 + +score: 返回大于等于这个分数的电影 + +city: 城市的中文名，可选，默认北京 + +### 即将上映的电影 + +举例: [https://rsshub.app/douban/movie/later](https://rsshub.app/douban/movie/later) + +路由: `/douban/movie/later` + +参数: 无 + +### 北美票房榜 + +举例: [https://rsshub.app/douban/movie/ustop](https://rsshub.app/douban/movie/ustop) + +路由: `/douban/movie/ustop` + +参数: 无 + +### 豆瓣小组 + +举例: [https://rsshub.app/douban/group/camera](https://rsshub.app/douban/group/camera) + +路由: `/douban/group/:groupid` + +参数: +groupid: 豆瓣小组的 id + +## 煎蛋 + +### 无聊图 + +举例: [https://rsshub.app/jandan/pic](https://rsshub.app/jandan/pic) + +路由: `/jandan/:sub_model` + +### 妹子图 + +举例: [https://rsshub.app/jandan/ooxx](https://rsshub.app/jandan/ooxx) + +路由: `/jandan/:sub_model` + +参数: 无 + +## 喷嚏 + +### 图卦 + +举例: [https://rsshub.app/dapenti/tugua](https://rsshub.app/dapenti/tugua) + +路由: `/dapenti/tugua` + +参数: 无 + +## Dockone + +### 周报 + +举例: [https://rsshub.app/dockone/weekly](https://rsshub.app/dockone/weekly) + +路由: `/dockone/weekly` + +参数: 无 + +## 腾讯吐个槽 + +### 吐槽新帖 + +举例: [https://rsshub.app/tucaoqq/post/28564/CdRI0728](https://rsshub.app/tucaoqq/post/28564/CdRI0728) + +路由: `/tucaoqq/post/:project/:key` + +参数 + +project: 产品 ID + +key: 产品密钥 + +## 笔趣阁 + +### 小说章节 + +举例: [https://rsshub.app/biquge/novel/latestchapter/52_52542](https://rsshub.app/biquge/novel/latestchapter/52_52542) + +路由: `/biquge/novel/latestchapter/:id` + +参数: id，小说 id，可在对应小说页 URL 中找到 + +::: tip 提示 + +由于笔趣阁网站有多个，各站点小说对应的小说 id 不同。此 feed 只对应在[`www.biquge5200.com`](https://www.biquge5200.com/)中的小说 id。 + +::: + +## 开发者头条 + +### 今天头条 + +举例: [https://rsshub.app/toutiao/today](https://rsshub.app/toutiao/today) + +路由: `/toutiao/today` + +### 独家号 + +举例: [https://rsshub.app/toutiao/user/140544](https://rsshub.app/toutiao/user/140544) + +路由: `/toutiao/user/:id` + +参数: id，独家号 id，可在对应独家号页 URL 中找到 + +## 今日头条 + +### 关键词 + +举例: [https://rsshub.app/jinritoutiao/keyword/ai](https://rsshub.app/jinritoutiao/keyword/ai) + +路由: `/jinritoutiao/keyword/:keyword` + +参数: keyword，关键词 + +## 极客时间 + +### 专栏文章 + +> 极客时间专栏需要付费订阅，RSS 仅做更新提醒，不含付费内容。 + +举例: [https://rsshub.app/geektime/column/48](https://rsshub.app/geektime/column/48) + +路由: `/geektime/column/:cid` + +参数: cid，专栏 id，可从[全部专栏](https://time.geekbang.org/paid-content)进入专栏介绍页，在 URL 中找到 + +## 央视新闻 + +### 专题 + +举例: [https://rsshub.app/cctv/world](https://rsshub.app/cctv/world) + +路由: `/cctv/:category` + +参数：category，分类名 + +| 国内 | 国际 | 视频 | 科技 | 社会 | 法律 | 娱乐 | +| ----- | ----- | ----- | ---- | ------- | ---- | ---- | +| china | world | video | tech | society | law | ent | + +## Disqus + +### 评论 + +举例: [https://rsshub.app/disqus/posts/diygod-me](https://rsshub.app/disqus/posts/diygod-me) + +路由: `/disqus/posts/:forum` + +参数: forum，网站的 disqus name + +## Twitter + +### 用户 + +举例: [https://rsshub.app/twitter/user/DIYgod](https://rsshub.app/twitter/user/DIYgod) + +路由: `/twitter/user/:id` + +参数: id，用户 id + +## Instagram + +### 用户 + +举例: [https://rsshub.app/instagram/user/diygod](https://rsshub.app/instagram/user/diygod) + +路由: `/instagram/user/:id` + +参数: id，用户 id + +## Youtube + +### 用户 + +举例: [https://rsshub.app/youtube/user/JFlaMusic](https://rsshub.app/youtube/user/JFlaMusic) + +路由: `/youtube/user/:username` + +参数: username，用户名 + +### 频道 + +举例: [https://rsshub.app/youtube/channel/UCDwDMPOZfxVV0x_dz0eQ8KQ](https://rsshub.app/youtube/channel/UCDwDMPOZfxVV0x_dz0eQ8KQ) + +路由: `/youtube/channel/:id` + +参数: id，频道 id + +## 爱奇艺 + +### 动漫 + +举例: [https://rsshub.app/iqiyi/dongman/a_19rrh1sifx](https://rsshub.app/iqiyi/dongman/a_19rrh1sifx) + +路由: `/iqiyi/dongman/:id` + +参数: id，动漫 id，可在该动漫主页 URL 中找到(不包括`.html`) + +## 南方周末 + +### 新闻分类 + +举例：[https://rsshub.app/infzm/5](https://rsshub.app/infzm/5) + +路由: `/infzm/:id` + +参数: id，南方周末内容分区 id，可在该内容分区的 URL 中找到(即http://www.infzm.com/contents/:id)，注意 contents 为内容分区，content 为文章页，添加前请留意。下面给出部分参考： + +| 全站 | 新闻 | 经济 | 文化 | 评论 | 图片 | 生活 | 时政 | 社会 | 科技 | 绿色 | 头条 | +| ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | +| 0 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 1374 | 2553 | + +## Dribbble + +### 流行 + +举例: + +[https://rsshub.app/dribbble/popular](https://rsshub.app/dribbble/popular) + +[https://rsshub.app/dribbble/popular/week](https://rsshub.app/dribbble/popular/week) + +路由: `/dribbble/popular/:timeframe?` + +参数: timeframe，可选，时间维度，支持 week month year ever + +### 用户（团队） + +举例: [https://rsshub.app/dribbble/user/google](https://rsshub.app/dribbble/user/google) + +路由: `/dribbble/user/:name` + +参数: name，用户名，可在该用户主页 URL 中找到 + +### 关键词 + +举例: [https://rsshub.app/dribbble/keyword/player](https://rsshub.app/dribbble/keyword/player) + +路由: `/dribbble/keyword/:keyword` + +参数: keyword，想要订阅的关键词 + +## 斗鱼 + +### 直播间开播 + +举例: [https://rsshub.app/douyu/room/24422](https://rsshub.app/douyu/room/24422) + +路由: `/douyu/room/:id` + +参数: id，直播间 id，可在主播直播间页 URL 中找到 + +## 熊猫直播 + +### 直播间开播下播 + +举例: [https://rsshub.app/panda/room/10300](https://rsshub.app/panda/room/10300) + +路由: `/panda/room/:id` + +参数: id，直播间 id，可在主播直播间页 URL 中找到 + +## V2EX + +### 最热/最新主题 + +举例: [https://rsshub.app/v2ex/topics/latest](https://rsshub.app/v2ex/topics/latest) + +路由: `/v2ex/topics/:type` + +参数: type: hot 或 latest + +## Telegram + +### 频道 + +::: tip 提示 + +订阅要求：将机器人 [@RSSHub_bot](https://t.me/RSSHub_bot) 加为频道管理员，然后发一条消息后才可正常获取数据 + +::: + +举例: [https://rsshub.app/telegram/channel/awesomeDIYgod](https://rsshub.app/telegram/channel/awesomeDIYgod) + +路由: `/telegram/channel/:username` + +参数: username，频道 username + +## Readhub + +### 分类 + +举例: [https://rsshub.app/readhub/category/topic](https://rsshub.app/readhub/category/topic) + +路由: `/readhub/category/:category` + +参数: category，分类名 + +| 热门话题 | 科技动态 | 开发者资讯 | 区块链快讯 | +| -------- | -------- | ---------- | ---------- | +| topic | news | technews | blockchain | + +## Konachan Anime Wallpapers + +::: tip 提示 + +- tags 可以在 [konachan](https://konachan.com/post) 选好后, 复制其 URL 中 tags= 后的参数 +- 路由可选 `/konachan` 或 `/konachan.com` 或 `/konachan.net`, 其中前两者相同, `.net` 是全年龄健康的壁纸 ♡ + +::: + +### Posts + +路由: + +- `/konachan/post` +- `/konachan/post/:tags` + +举例: + +- [https://rsshub.app/konachan/post](https://rsshub.app/konachan/post) +- [https://rsshub.app/konachan/post/touhou](https://rsshub.app/konachan/post/touhou) +- [https://rsshub.app/konachan/post/panties+rating%3Asafe](https://rsshub.app/konachan/post/panties+rating%3Asafe) + +### Popular Recent Posts + +路由: + +- `/konachan/post/popular_recent` 默认过去 24 小时 +- `/konachan/post/popular_recent/:period` + +举例: + +- 过去 24 小时:[https://rsshub.app/konachan/post/popular_recent/1d](https://rsshub.app/konachan/post/popular_recent/1d) +- 过去一周:[https://rsshub.app/konachan/post/popular_recent/1w](https://rsshub.app/konachan/post/popular_recent/1w) +- 过去一月:[https://rsshub.app/konachan/post/popular_recent/1m](https://rsshub.app/konachan/post/popular_recent/1m) +- 过去一年:[https://rsshub.app/konachan/post/popular_recent/1y](https://rsshub.app/konachan/post/popular_recent?period=1y) + +## yande.re + +### Posts + +路由: + +- `/yande.re/post` +- `/yande.re/post/:tags` + +举例: + +- [https://rsshub.app/yande.re/post](https://rsshub.app/yande.re/post) +- [https://rsshub.app/yande.re/post/the_idolm%40ster](https://rsshub.app/yande.re/post/the_idolm%40ster) +- [https://rsshub.app/yande.re/post/kantai_collection](https://rsshub.app/yande.re/post/kantai_collection) +- [https://rsshub.app/yande.re/post/love_live%21](https://rsshub.app/yande.re/post/love_live%21) + +### Popular Recent Posts + +路由: + +- `/yande.re/post/popular_recent` 默认过去 24 小时 +- `/yande.re/post/popular_recent/:period` + +举例: + +- 过去 24 小时:[https://rsshub.app/yande.re/post/popular_recent/1d](https://rsshub.app/yande.re/post/popular_recent/1d) +- 过去一周:[https://rsshub.app/yande.re/post/popular_recent/1w](https://rsshub.app/yande.re/post/popular_recent/1w) +- 过去一月:[https://rsshub.app/yande.re/post/popular_recent/1m](https://rsshub.app/yande.re/post/popular_recent/1m) +- 过去一年:[https://rsshub.app/yande.re/post/popular_recent/1y](https://rsshub.app/yande.re/post/popular_recent?period=1y) + +## GitHub + +::: tip 提示 + +GitHub 官方也提供了一些 RSS: + +- 仓库 releases: https://github.com/:owner/:repo/releases.atom +- 仓库 commits: https://github.com/:owner/:repo/commits.atom +- 用户动态: https://github.com/:user.atom + +::: + +### 用户仓库 + +举例: [https://rsshub.app/github/repos/DIYgod](https://rsshub.app/github/repos/DIYgod) + +路由: `/github/repos/:user` + +参数: user，用户名 + +### Trending + +举例: + +[https://rsshub.app/github/trending/daily](https://rsshub.app/github/trending/daily) + +[https://rsshub.app/github/trending/daily/javascript](https://rsshub.app/github/trending/daily/javascript) + +路由: `/github/trending/:since/:language?` + +参数: + +since，时间跨度，可在 [Trending 页](https://github.com/trending/javascript?since=monthly) URL 中找到，可选 daily weekly monthly + +language，语言，可在 [Trending 页](https://github.com/trending/javascript?since=monthly) URL 中找到 + +### Issue + +举例: [https://rsshub.app/github/issue/DIYgod/RSSHub](https://rsshub.app/github/issue/DIYgod/RSSHub) + +路由: `/github/issue/:user/:repo` + +参数: user，用户名 +参数: repo，仓库名 + +## 纽约时报 + +::: tip 提示 + +纽约时报 RSS: https://cn.nytimes.com/rss/ + +::: + +### 新闻早报 + +举例: [https://rsshub.app/nytimes/morning_post](https://rsshub.app/nytimes/morning_post) + +路由: `/nytimes/morning_post` + +参数: 无 + +## UU 看书 + +### 小说章节 + +举例: [https://rsshub.app/uukanshu/chapter/49621](https://rsshub.app/uukanshu/chapter/49621) + +路由: `/uukanshu/chapter/:id` + +参数: id，小说 id，可在对应小说页 URL 中找到 + +## 3DMGame + +### 新闻中心 + +举例: [https://rsshub.app/3dm/news](https://rsshub.app/3dm/news) + +路由: `/3dm/news` + +参数: 无 + +### 新闻 + +举例: [https://rsshub.app/3dm/detroitbecomehuman/news](https://rsshub.app/3dm/detroitbecomehuman/news) + +路由: `/3dm/:name/news` + +参数: name，游戏的编号可以在专题页的 url 中找到 + +### 攻略 + +举例: [https://rsshub.app/3dm/detroitbecomehuman/gl](https://rsshub.app/3dm/detroitbecomehuman/gl) + +路由: `/3dm/:name/gl` + +参数: name，游戏的编号可以在专题页的 url 中找到 + +### 下载 + +举例: [https://rsshub.app/3dm/detroitbecomehuman/download](https://rsshub.app/3dm/detroitbecomehuman/download) + +路由: `/3dm/:name/download` + +参数: name，游戏的编号可以在专题页的 url 中找到 + +## 喜马拉雅 + +### 专辑 + +举例: [https://rsshub.app/ximalaya/album/shangye/299146/](https://rsshub.app/ximalaya/album/shangye/299146/) + +路由: `/ximalaya/album/:classify/:id` + +参数: + +classify, 专辑分类, 可在对应专辑页面的 URL 中找到 + +id, 专辑 id, 可在对应专辑页面的 URL 中找到 + +## EZTV + +::: tip 提示 + +网站提供了全部种子的 RSS：https://eztv.ag/ezrss.xml + +::: + +### Lookup Torrents by IMDB ID + +举例: [https://rsshub.app/eztv/torrents/6048596](https://rsshub.app/eztv/torrent/6048596) + +路由: `/eztv/torrents/:imdb_id` + +参数: imdb_id，想搜寻的 show 的种子所对应的 IMDB ID，可在 [IMDB](https://www.imdb.com) 官网找到 + +## 什么值得买 + +::: tip 提示 + +网站也提供了部分 RSS：https://www.smzdm.com/dingyue + +::: + +### 关键词 + +举例: [https://rsshub.app/smzdm/keyword/女装](https://rsshub.app/smzdm/keyword/女装) + +路由: `/smzdm/keyword/:keyword` + +参数: keyword，你想订阅的关键词 + +### 排行榜 + +举例: [https://rsshub.app/smzdm/ranking/pinlei/11/3](https://rsshub.app/smzdm/ranking/pinlei/11/3) + +路由: `/smzdm/ranking/:rank_type/:rank_id/:hour` + +参数 + +**rank_type** + +| 好价品类榜 | 好价电商榜 | 海淘 TOP 榜 | 好文排行榜 | 好物排行榜 | +| ---------- | ---------- | ----------- | ---------- | ---------- | +| pinlei | dianshang | haitao | haowen | haowu | + +**rank_id** + +好价品类榜 + +| 全部 | 时尚运动 | 3C 家电 | 食品家居 | 日百母婴 | 出行游玩 | 白菜 | 凑单品 | +| ---- | -------- | ------- | -------- | -------- | -------- | ---- | ------ | +| 11 | 12 | 13 | 14 | 15 | 16 | 17 | 22 | + +好价电商榜 + +| 券活动 | 京东 | 天猫 | 亚马逊中国 | 国美在线 | 苏宁易购 | 网易 | 西集网 | 美国亚马逊 | 日本亚马逊 | ebay | +| ------ | ---- | ---- | ---------- | -------- | -------- | ---- | ------ | ---------- | ---------- | ---- | +| 24 | 23 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | + +海淘 TOP 榜 + +| 全部 | 海外直邮 | 美国榜 | 欧洲榜 | 澳新榜 | 亚洲榜 | 晒物榜 | +| ---- | -------- | ------ | ------ | ------ | ------ | ------ | +| 39 | 34 | 35 | 36 | 37 | 38 | hsw | + +好文排行榜 + +| 原创 | 资讯 | +| ---- | ---- | +| yc | zx | + +好物排行榜 + +| 新晋榜 | 消费众测 | 新锐品牌 | 好物榜单 | +| ------ | -------- | -------- | -------- | +| hwall | zc | nb | hw | + +**hour**: 时间跨度 + +## 上海海事大学 + +### 学术讲座 + +举例: [https://rsshub.app/shmtu/events](https://rsshub.app/shmtu/events) + +路由: `/shmtu/events` + +参数: 无 + +### 通知公告 + +举例: [https://rsshub.app/shmtu/notes](https://rsshub.app/shmtu/notes) + +路由: `/shmtu/notes` + +参数: 无 + +### 教务信息 + +举例: [https://rsshub.app/shmtu/jwc/1](https://rsshub.app/shmtu/jwc/1) + +路由: `/shmtu/jwc/:type` + +参数: type，1 为教务新闻,2 为教务公告 + +## 新京报 + +### 栏目 + +举例: [https://rsshub.app/bjnews/realtime](https://rsshub.app/bjnews/realtime) + +路由： `/bjnews/:category` + +参数: category，新京报的栏目名，点击对应栏目后在地址栏找到 + +## 停水通知 + +配合 [IFTTT](https://ifttt.com/) Applets [邮件通知](https://ifttt.com/applets/SEvmDVKY-) 使用实现自动通知效果 + +### 杭州市 + +举例: [https://rsshub.app/tingshuitz/hangzhou](https://rsshub.app/tingshuitz/hangzhou) + +路由: `/tingshuitz/hangzhou` + +参数: 无 + +### 萧山区 + +举例: [https://rsshub.app/tingshuitz/xiaoshan](https://rsshub.app/tingshuitz/xiaoshan) + +路由: `/tingshuitz/xiaoshan` + +参数: 无 + +### 大连市 + +举例: [https://rsshub.app/tingshuitz/dalian](https://rsshub.app/tingshuitz/dalian) + +路由: `/tingshuitz/dalian` + +参数: 无 + +## 米哈游 + +### 崩坏 2-游戏公告 + +举例: [https://rsshub.app/mihoyo/bh2/gach](https://rsshub.app/mihoyo/bh2/gach) + +路由: `/mihoyo/bh2/:type` + +参数：type，公告种类 + +| 最新公告 | 版本信息 | 祈愿信息 | 活动介绍 | +| -------- | -------- | -------- | -------- | +| new | version | gach | event | + +### 崩坏 3-游戏公告 + +举例: [https://rsshub.app/mihoyo/bh3/strategy](https://rsshub.app/mihoyo/bh3/strategy) + +路由: `/mihoyo/bh3/:type` + +参数：type，公告种类 + +| 最新 | 公告 | 新闻 | 活动 | 攻略 | +| ------ | ------ | ---- | -------- | -------- | +| latest | notice | news | activity | strategy | + +## 灵梦御所 + +### 分类 + +举例: [https://rsshub.app/reimu/category/music](https://rsshub.app/reimu/category/music) + +路由: `/reimu/category/:category` + +参数：category，分类名 + +| 3d | 动画 | 合集 | 图包 | 壁纸 | 御所汉化 | 游戏 | 漫画 | 独立 | 表番推荐 | 音声 | +| --- | ----- | ---------- | ------- | --------- | -------- | ---- | ----- | ----- | --------- | ----- | +| 3d | anime | collection | picture | wallpaper | chinese | game | comic | indie | recommend | music | + +### 标签 + +举例: [https://rsshub.app/reimu/tag/ntr](https://rsshub.app/reimu/tag/ntr) + +路由: `/reimu/tag/:tag` + +参数：tag，标签名，例如: **ntr**, **rbq**, **凌辱** + +## 草榴社区 + +### 分区帖子 + +举例: [https://rsshub.app/t66y/7](https://rsshub.app/t66y/7) + +路由: `/t66y/:id` + +参数: id，分区 id，可在分区页 URL 中找到 + +| 亚洲无码原创区 | 亚洲有码原创区 | 欧美原创区 | 动漫原创区 | 国产原创区 | +| -------------- | -------------- | ---------- | ---------- | ---------- | +| 2 | 15 | 4 | 5 | 25 | + +| 中字原创区 | 转帖交流区 | HTTP 下载区 | 在线成人区 | +| ---------- | ---------- | ----------- | ---------- | +| 26 | 27 | 21 | 22 | + +| 技术讨论区 | 新时代的我们 | 达盖尔的旗帜 | +| ---------- | ------------ | ------------ | +| 7 | 8 | 16 | + +## 科技星球 + +### 首页 + +举例: [https://rsshub.app/kejixingqiu/home](https://rsshub.app/kejixingqiu/home) + +路由: `/kejixingqiu/home` + +## 北大信科 + +### 公告通知 + +举例: [https://rsshub.app/pku/eecs/0](https://rsshub.app/pku/eecs/0) + +路由: `/eecs/:type` + +可选参数: type，分区 type，可在网页 URL 中找到 + +| 全部 | 学院通知 | 人事通知 | 教务通知 | 学工通知 | 科研通知 | 财务通知 | 工会通知 | 院友通知 | +| ---- | -------- | -------- | -------- | -------- | -------- | -------- | -------- | -------- | +| 0 | 1 | 2 | 6 | 8 | 7 | 5 | 3 | 4 | + +## 机核网 + +### 分类 + +举例: [https://rsshub.app/gcores/category/1](https://rsshub.app/gcores/category/1) + +路由: `/gcores/category/:category` + +参数: category，分类名 + +| 文章 | 新闻 | 电台 | +| ---- | ---- | ---- | +| 1 | 2 | 9 | + +## 国家地理 + +### 分类 + +举例: + +[https://rsshub.app/natgeo/travel](https://rsshub.app/natgeo/travel) + +[https://rsshub.app/natgeo/news/ngnews](https://rsshub.app/natgeo/news/ngnews) + +路由： `/natgeo/:cat/:type?` + +参数： cat, 分类; type, 类型 + +可在 url 中获取，例如`https://www.natgeomedia.com/category/news/ngnews`对应 cat, type 分别为 news, ngnews + +## ONE · 一个 + +举例： [https://rsshub.app/one](https://rsshub.app/one) + +路由: `/one` + +参数: 无 + +## 推酷 + +### 周刊 + +举例: [https://rsshub.app/tuicool/mags/tech](https://rsshub.app/tuicool/mags/tech) + +路由: `/tuicool/mags/:type` + +参数: type + +| 编程狂人 | 设计匠艺 | 创业周刊 | 科技周刊 | +| -------- | -------- | -------- | -------- | +| prog | design | startup | tech | + +## Hexo + +### Next 主题 + +举例：[http://rsshub.app/hexo/next/fengkx.top](http://rsshub.app/hexo/next/fengkx.top) + +路由： `/hexo/next/:url` + +参数： url 博客 Url 不带协议头 + +## 小米 + +### 众筹 + +举例： [https://rsshub.app/mi/crowdfunding](https://rsshub.app/mi/crowdfunding) + +路由: `/mi/crowdfunding` + +参数: 无 + +## 华南师范大学 + +### 教务处通知 + +举例： [https://rsshub.app/scnu/jw](https://rsshub.app/scnu/jw) + +路由： `/scnu/jw` + +参数：无 + +### 图书馆通知 + +举例： [https://rsshub.app/scnu/library](https://rsshub.app/scnu/library) + +路由： `/scnu/library` + +参数：无 + +### 计算机学院竞赛通知 + +举例： [https://rsshub.app/scnu/cs/match](https://rsshub.app/scnu/cs/match) + +路由： `/scnu/cs/match` + +参数：无 + +## Keep + +### 运动日记 + +举例：[https://rsshub.app/keep/user/556b02c1ab59390afea671ea](https://rsshub.app/keep/user/556b02c1ab59390afea671ea) + +路由: `/keep/user/:id` + +参数: id，Keep 用户 id + +## 起点 + +### 章节 + +举例： [https://rsshub.app/qidian/chapter/1010400217](https://rsshub.app/qidian/chapter/1010400217) + +路由： `/qidian/chapter/:id` + +参数: id，小说 id，可在对应小说页 URL 中找到 + +### 讨论区 + +举例： [https://rsshub.app/qidian/forum/1010400217](https://rsshub.app/qidian/forum/1010400217) + +路由： `/qidian/forum/:id` + +参数: id，小说 id，可在对应小说页 URL 中找到 + +## 懂球帝 + +### 早报 + +举例： [https://rsshub.app/dongqiudi/daily](https://rsshub.app/dongqiudi/daily) + +路由： `/dongqiudi/daily` + +参数：无 + +## 维基百科 + +### 中国大陆新闻动态 + +举例： [https://rsshub.app/wikipedia/mainland](https://rsshub.app/wikipedia/mainland) + +路由： `/wikipedia/mainland` + +参数：无 + +## 雪球 + +### 用户动态 + +举例: [https://rsshub.app/xueqiu/user/8152922548](https://rsshub.app/xueqiu/user/8152922548) + +路由: `/xueqiu/user/:id/:type?` + +参数: + +id，用户 id，可在用户主页 URL 中找到 + +type，可选，动态的类型，不填则默认全部 + +| 原发布 | 长文 | 问答 | 热门 | 交易 | +| ------ | ---- | ---- | ---- | ---- | +| 0 | 2 | 4 | 9 | 11 | + +### 用户收藏动态 + +举例: [https://rsshub.app/xueqiu/favorite/8152922548](https://rsshub.app/xueqiu/favorite/8152922548) + +路由: `/xueqiu/favorite/:id` + +参数: + +id，用户 id，可在用户主页 URL 中找到 + +## 中国美术馆 + +### 通知公告 + +举例： [https://rsshub.app/namoc/announcement](https://rsshub.app/namoc/announcement) + +路由： `/namoc/announcement` + +参数：无 + +### 新闻 + +举例： [https://rsshub.app/namoc/news](https://rsshub.app/namoc/news) + +路由： `/namoc/news` + +参数：无 + +### 媒体联报 + +举例： [https://rsshub.app/namoc/media](https://rsshub.app/namoc/media) + +路由： `/namoc/media` + +参数：无 + +### 展览预告 + +举例： [https://rsshub.app/namoc/exhibition](https://rsshub.app/namoc/exhibition) + +路由： `/namoc/exhibition` + +参数：无 + +### 焦点专题 + +举例： [https://rsshub.app/namoc/specials](https://rsshub.app/namoc/specials) + +路由： `/namoc/specials` + +参数：无 + +## Greasy Fork + +### 脚本更新 + +举例: [https://rsshub.app/greasyfork/zh-CN/bilibili.com](https://rsshub.app/greasyfork/zh-CN/bilibili.com) + +路由: `/greasyfork/:language/:domain?` + +参数: + +language，语言，可在网站右上角找到， `all` 为所有语言 + +domain，按脚本生效域名过滤，可选 + +## LinkedKeeper + +### 博文 + +举例: [https://rsshub.app/linkedkeeper/sub/1](https://rsshub.app/linkedkeeper/sub/1) + +路由: `/linkedkeeper/:type/:id?` + +参数: + +type，博文分类，为 URL 中 `.action` 的文件名 + +id，可选，分区或标签的 ID，对应 URL 中的 `sid` 或 `tid` + +## 开源中国 + +### 资讯 + +举例: [https://rsshub.app/oschina/news](https://rsshub.app/oschina/news) + +路由: `/oschina/news` + +参数：无 + +## All the Flight Deals + +### 特价机票 Flight Deals + +举例: [https://rsshub.app/atfd/us+new york,gb+london/1](https://rsshub.app/atfd/us+new york,gb+london/1) + +路由: `/atfd/:locations/:nearby?` + +参数: + +locations: + + 1. 始发地 ISO 3166-1 国家代码+城市名称，例如 `us+new york`，https://rsshub.app/atfd/us+new york + 2. 支持逗号区分多个始发地，例如 `us+new york,gb+london`，https://rsshub.app/atfd/us+new york,gb+london/ + + ISO 3166-1 国家代码列表请参见 https://en.wikipedia.org/wiki/ISO_3166-1 + +nearby: 可选 0 或 1，默认 0 为不包括，是否包括临近机场 diff --git a/docs/en/install/README.md b/docs/en/install/README.md new file mode 100644 index 0000000000..d4725991a8 --- /dev/null +++ b/docs/en/install/README.md @@ -0,0 +1,408 @@ +--- +sidebar: auto +--- + +# 部署 + +部署 RSSHub 非常简单，如果您在部署过程中遇到无法解决的问题请到 [issues](https://github.com/DIYgod/RSSHub/issues) 寻找类似的问题或 [向我们提问](https://github.com/DIYgod/RSSHub/issues/new)，我们会尽快给您答复。 + +## 手动部署 + +部署 `RSSHub` 最直接的方式，您可以按照以下步骤将 `RSSHub` 部署在您的 电脑、服务器或者其他任何地方。 + +### 在安装之前 + +在安装 RSSHub 之前，请确保您的电脑中已经安装了 [Git](https://git-scm.com/) 和 [Node.js >= 8.0.0](https://nodejs.org/)。 + +### 安装 Git + +::: tip 提示 + +首先您应该输入 `git`，看看系统有没有安装 Git： + +windows 打开 `cmd`， macOS 打开`终端(terminal)`。 + +```bash +$ git +usage: git [--version] [--help] [-C ] [-c name=value] +... +``` + +::: + +- Windows：从 Git 官网直接[下载安装程序](https://git-scm.com/downloads)。 +- MacOS：使用 [Homebrew](https://brew.sh/) `$ brew install git` 或者[下载安装程序](https://git-scm.com/download/mac)。 +- Linux：使用您的包管理器安装例如 `$ sudo apt-get install git`。 + +### 安装 Node.JS + +#### Windows + +Windows 用户请 [下载安装程序](https://nodejs.org/zh-cn/)。安装时，请勾选`Add to PATH`选项。 + +#### MacOS & Linux + +安装 NodeJS 的最佳方式是使用 [nvm](https://github.com/creationix/nvm)。 + +安装 `nvm` + +```bash +$ curl https://raw.github.com/creationix/nvm/master/install.sh | sh +``` + +安装完成后，重启终端并执行下列命令即可安装 `Node.js`。 + +```bash +$ nvm install node +``` + +### 安装 RSSHub + +首先是下载 `RSSHub` 的源码，请执行下列命令。 + +```bash +$ git clone https://github.com/DIYgod/RSSHub.git +$ cd RSSHub +``` + +下载完成后，需要安装依赖。 + +```bash +$ npm install +``` + +::: tip 提示 + +推荐使用 [Yarn](https://yarn.bootcss.com/) ，`Yarn` 比 `npm` 更快更稳定。 + +使用 `Yarn` 安装依赖时只需要键入 + +```bash +$ yarn +``` + +由于众所周知的原因，在中国使用 `npm` 下载依赖十分缓慢，建议挂一个代理或者考虑使用 [NPM 镜像](https://npm.taobao.org/)。 + +::: + +### 启动 + +在 `RSSHub` 文件夹中运行下面的命令就可以启动。 + +```bash +$ npm start +``` + +在浏览器中打开 [http://127.0.0.1:1200/](http://127.0.0.1:1200/)，enjoy it! ✅ + +### 更新 + +在 `RSSHub` 文件夹中运行下面的命令就从 github 仓库拉取最新版本。 + +```bash +$ git pull +``` + +### 添加配置 + +可以通过修改 `config.js` 或者设置环境变量来配置 RSSHub。 + +**如何设置环境变量** + +Windows 系统在 cmd.exe 中运行 `$ set PORT=1000` + +macOS & Linux 运行 `$ PORT=1000` + +再运行 `$ npm start` 启动 RSSHub 即可将监听端口设置为 `1000`。 + +此处设置的环境变量在关闭终端后就会被清除，如果您想保存这些配置可以编写一个简单的 [批处理文件](https://en.wikipedia.org/wiki/Batch_file) 或 [shell](https://en.wikipedia.org/wiki/Shell_script)。 + +更多配置项请看 [应用配置](#应用配置) + +### 使用 Redis 数据库缓存 + +RSSHub 默认会有 5 分钟的缓存，默认这个缓存是存放在内存中的。RSSHub 还支持 Redis 数据库缓存。 + +::: tip 提示 + +除非流量特别大或者您需要建立分布式集群，否则不需要 Redis 缓存。 + +::: + +#### 安装 Redis + +**Windows** + +安装 Redis on Windows 直接[下载安装程序](https://github.com/MicrosoftArchive/redis/releases)。 + +在安装目录中运行下面的命令启动 Redis。 + +```bash +$ redis-server redis.windows.conf +``` + +**MacOS** + +使用 [Homebrew](https://brew.sh/) 安装 Redis。 + +```bash +$ brew install redis +``` + +再运行下面的命令启动 Redis。 + +```bash +$ brew services start redis +``` + +**Linux** + +使用您的包管理器安装 Redis。 + +```bash +# apt +$ sudo apt install redis-server + +# yum +$ sudo yum install redis +``` + +然后运行 `$ redis-server` 启动 Redis。 + +#### 启用 Redis 数据库缓存 + +修改配置项 `CACHE_TYPE` 为 `redis`，RSSHub 将使用默认地址 `redis://localhost:6379/` 连接 Redis，如果需要修改地址请看 [应用配置](#应用配置)。 + +## 部署到 Docker + +Docker 属于 Linux 容器的一种封装，提供简单易用的容器使用接口。它是目前最流行的 Linux 容器解决方案。 + +### 安装 Docker + +官方网站上有各种环境下的 [安装指南](https://docs.docker.com/engine/installation/) + +### 部署 + +运行下面的命令下载 RSSHub 镜像。 + +```bash +$ docker pull diygod/rsshub +``` + +然后运行 RSSHub 即可 + +```bash +$ docker run -d --name rsshub -p 1200:1200 diygod/rsshub +``` + +在浏览器中打开 [http://127.0.0.1:1200/](http://127.0.0.1:1200/)，enjoy it! ✅ + +您可以使用下面的命令来关闭 RSSHub。 + +```bash +$ docker stop rsshub +``` + +### 更新 + +您可以使用下面的命令来更新镜像。 + +```bash +# 先关闭 rsshub +$ docker stop rsshub + +# 删除现有的容器 +$ docker rm rsshub + +# 下载最新版的 rsshub 镜像 +$ docker pull diygod/rsshub +``` + +### 添加配置 + +配置运行在 docker 中的 RSSHub，最便利的方法是使用环境变量。 + +以设置缓存时间为 1 小时举例，只需要在运行时增加参数：`-e CACHE_EXPIRE=3600` + +```bash +$ docker run -d --name rsshub -p 1200:1200 -e CACHE_EXPIRE=3600 -e GITHUB_ACCESS_TOKEN=example diygod/rsshub +``` + +更多配置项请看 [应用配置](#应用配置) + +### 使用 docker-compose 部署 + +[docker-compose](https://docs.docker.com/compose/overview/) 是用来运行多容器 Docker 应用的小工具，可以简化配置部署过程： + +1. 创建 volume 持久化 Redis 缓存 + +```bash +$ docker volume create redis-data +``` + +2. 修改 [docker-compose.yml](https://github.com/DIYgod/RSSHub/blob/master/docker-compose.yml) 中的 `environment` 进行配置 + +3. 部署 + +```bash +$ docker-compose up +``` + +4. 更新 + +```bash +$ docker-compose build +$ docker-compose up +``` + +## 部署到 Heroku + +[![Deploy](https://i.imgur.com/e6ZcmUY.png)](https://heroku.com/deploy?template=https%3A%2F%2Fgithub.com%2FDIYgod%2FRSSHub) + +## 部署到 Google App Engine + +### 部署之前 + +[Before you begin](https://cloud.google.com/appengine/docs/flexible/nodejs/quickstart) + +按照这里的引导完成 GCP 账号设置，创建 GCP 项目，创建 App Engine 项目，开通付费功能（必须），安装 git 与 gcloud 工具。并完成 gcloud 工具的初始化，初始化具体方式[请查看这个链接](https://cloud.google.com/sdk/gcloud/?hl=zh-CN)。如果你不打算在本地调试本项目，可以不安装 Node.js 环境。 + +请注意，GAE 免费用量不支持 Flexible Environment ，部署至 Flexible Environment 前请确认收费标准。 + +Node.JS 的 standard environment 仍在测试中，您可能会在部署或使用中遇到某些不可预期的问题。 + +### 拉取 + +运行 `git clone https://github.com/DIYgod/RSSHub.git` 拉取本项目的最新版本。 + +### app.yaml 配置 + +#### 部署至 Flexible Environment + +在 RSSHub 项目根目录下建立一个 app.yaml 文件，内容示例如下： + +```yaml +# [START app_yaml] +runtime: custom +env: flex + +# This sample incurs costs to run on the App Engine flexible environment. +# The settings below are to reduce costs during testing and are not appropriate +# for production use. For more information, see: +# https://cloud.google.com/appengine/docs/flexible/nodejs/configuring-your-app-with-app-yaml +manual_scaling: + instances: 1 +# 以下是 app engine 资源配置，可以自行修改，硬盘最低为 10G +resources: + cpu: 1 + memory_gb: 0.5 + disk_size_gb: 10 +network: + forwarded_ports: + - 80:1200 + - 443:1200 +# 以下是环境配置示例，具体可配置项见本文档配置章节 +env_variables: + CACHE_EXPIRE: "300" +# [END app_yaml] +``` + +#### 部署至 standard environment + +在 RSSHub 项目根目录下建立一个 app.yaml 文件，内容示例如下： + +```yaml +# [START app_yaml] +runtime: nodejs8 + +network: + forwarded_ports: + - 80:1200 + - 443:1200 +# 以下是环境配置示例，具体可配置项见本文档配置章节 +env_variables: + CACHE_EXPIRE: "300" +# [END app_yaml] +``` + +### 开始部署 + +在 RSSHub 项目根目录下运行 + +```bash +gcloud app deploy +``` + +进行项目部署，如果您需要变更 app.yaml 文件名称或者变更部署的项目 ID 或者指定版本号等，请参考[这个链接](https://cloud.google.com/appengine/docs/flexible/nodejs/testing-and-deploying-your-app)的"Deploying a service" 部分。 + +部署完成后可访问您的 Google App Engine URL 查看部署情况。 + +## 配置 + +### 应用配置 + +可以通过修改 `config.js` 或者设置环境变量来配置 RSSHub。 + +::: tip 提示 + +建议通过设置环境变量来配置 RSSHub。避免版本更新时的冲突。 + +::: + +`PORT`: 监听端口，默认为 `1200` + +`SOCKET`: 监听 Unix Socket，默认为 `null` + +`CACHE_TYPE`: 缓存类型，可为 `memory` 和 `redis`，设为空可以禁止缓存，默认为 `memory` + +`CACHE_EXPIRE`: 缓存过期时间，单位为秒，默认 300 + +`LISTEN_INADDR_ANY`: 是否允许公网连接，默认 1 + +`REDIS_URL`: Redis 连接地址（memory 缓存类型时无效），默认为 `redis://localhost:6379/` + +`REDIS_PASSWORD`: Redis 连接密码（memory 缓存类型时无效） + +### 部分 RSS 模块配置 + +- `pixiv`: [注册地址](https://accounts.pixiv.net/signup) + + - `PIXIV_USERNAME`: Pixiv 用户名 + + - `PIXIV_PASSWORD`: Pixiv 密码 + +- `disqus`: [申请地址](https://disqus.com/api/applications/) + + - `DISQUS_API_KEY`: Disqus API + +- `twitter`: [申请地址](https://apps.twitter.com) + + - `TWITTER_CONSUMER_KEY`: Twitter Consumer Key + + - `TWITTER_CONSUMER_SECRET`: Twitter Consumer Secret + + - `TWITTER_ACCESS_TOKEN`: Twitter Access Token + + - `TWITTER_ACCESS_TOKEN_SECRET`: Twitter Access Token Secret + +- `youtube`: [申请地址](https://console.developers.google.com/) + + - `YOUTUBE_KEY`: YouTube API Key + +- `telegram`: [Telegram 机器人](https://telegram.org/blog/bot-revolution) + + - `TELEGRAM_TOKEN`: Telegram 机器人 token + +- `github`: [申请地址](https://github.com/settings/tokens) + + - `GITHUB_ACCESS_TOKEN`: GitHub Access Token + +### 访问控制 + +可以通过修改 `middleware/access-control.js` 或者设置环境变量来配置黑名单和白名单。 + +支持 IP 和路由，设置多项时用英文逗号 `,` 隔开。同时设置黑名单和白名单时仅白名单有效。 + +- `BLACKLIST`: 黑名单 + +- `WHITELIST`: 白名单，设置白名单后黑名单无效 diff --git a/docs/en/joinus/README.md b/docs/en/joinus/README.md new file mode 100644 index 0000000000..7ad3ebb6c4 --- /dev/null +++ b/docs/en/joinus/README.md @@ -0,0 +1,71 @@ +--- +sidebar: auto +--- + +# 参与我们 + +如果有任何想法或需求，可以在 [issue](https://github.com/DIYgod/RSSHub/issues) 中告诉我们，同时我们欢迎各种 pull requests + +## 提交新的 RSS 内容 + +1. 在 [/router.js](https://github.com/DIYgod/RSSHub/blob/master/router.js) 里添加路由 + +1. 在 [/routes/](https://github.com/DIYgod/RSSHub/tree/master/routes) 中的路由对应路径添加获取 RSS 内容的脚本 + +1. 更新 [README (/README.md) ](https://github.com/DIYgod/RSSHub/blob/master/README.md) 和 [文档 (/docs/README.md) ](https://github.com/DIYgod/RSSHub/blob/master/docs/README.md)，可以执行 `npm run docs:dev` 查看文档效果 + +1. 执行 `npm run format` 自动处理代码格式后，提交代码，然后提交 pull request + +## 编写脚本 + +### 从接口获取数据 + +使用 [axios](https://github.com/axios/axios) 请求接口，然后把获取的标题、链接、描述、发布时间等数据赋值给 ctx.state.data（每个字段的含义在下面说明），可以直接看这个典型的例子：[/routes/bilibili/bangumi.js](https://github.com/DIYgod/RSSHub/blob/master/routes/bilibili/bangumi.js) + +### 从 HTML 获取数据 + +有时候数据是写在 HTML 里的，没有接口供我们调用，这时候可以使用 [axios](https://github.com/axios/axios) 请求 HTML 数据，然后使用 [cheerio](https://github.com/cheeriojs/cheerio) 解析 HTML，再把数据赋值给 ctx.state.data，可以直接看这个典型的例子：[/routes/jianshu/home.js](https://github.com/DIYgod/RSSHub/blob/master/routes/jianshu/home.js) + +### 使用缓存 + +所有路由都有一个缓存，缓存时间在 `config.js` 里设定，但某些接口返回的内容可能长时间都不会变化，这时应该给这些数据设置一个更长的缓存。 + +添加缓存: + +```js +ctx.cache.set((key: string), (value: string), (time: number)); // time 为缓存时间，单位为秒 +``` + +获取缓存: + +```js +const value = await ctx.cache.get(key: string); +``` + +可以直接看这个典型的例子：[/routes/zhihu/daily.js](https://github.com/DIYgod/RSSHub/blob/master/routes/zhihu/daily.js)，这个例子中需要获取每篇文章的详细内容，每篇文章都需要单独请求一次，请求很多而且每个请求只需要一次，这时候可以把结果缓存一天。 + +### 数据 + +获取到的数据赋给 ctx.state.data，然后数据会经过 [template.js](https://github.com/DIYgod/RSSHub/blob/master/middleware/template.js) 中间件处理，最后传到 [/views/rss.art](https://github.com/DIYgod/RSSHub/blob/master/views/rss.art) 来生成最后的 RSS 结果，每个字段的含义如下: + +```js +ctx.state.data = { + title: '', // 项目的标题 + link: '', // 指向项目的链接 + description: '', // 描述项目 + item: [ + // 其中一篇文章或一项内容 + { + title: '', // 文章标题 + description: '', // 文章内容或描述 + pubDate: '', // 文章发布时间 + guid: '', // 文章唯一标示，必须唯一，可选，默认为文章链接 + link: '', // 指向文章的链接 + }, + ], +}; +``` + +## 参与讨论 + +1. [Telegram 群](https://t.me/rsshub) diff --git a/docs/en/support/README.md b/docs/en/support/README.md new file mode 100644 index 0000000000..fd6855dedf --- /dev/null +++ b/docs/en/support/README.md @@ -0,0 +1,25 @@ +--- +sidebar: auto +--- + +# 支持 RSSHub + +RSSHub 是采用 MIT 许可的开源项目，使用完全免费。 但是随着项目规模的增长，也需要有相应的资金支持才能持续项目的维护与开发。 + +你可以通过下列的方法来赞助 RSSHub 的开发。 + +## 一次性赞助 + +我们通过以下方式接受赞助： + +- [微信支付](https://i.imgur.com/aq6PtWa.png) +- [支付宝](https://i.imgur.com/wv1Pj2k.png) +- [Paypal](https://www.paypal.me/DIYgod) +- 比特币: 13CwQLHzPYm2tewNMSJBeArbbRM5NSmCD1 + +## 周期性赞助 + +周期性赞助可以获得额外的回报，比如更快的 GitHub 响应或者你的名字会出现在 RSSHub 的 GitHub 仓库和现在我们的官网中。 + +- 通过 [Patreon](https://www.patreon.com/DIYgod) 赞助成为 backer 或 sponsor +- 给我们发邮件联系赞助事宜: i#html.love