opensource/RSSHub
3
0
Fork 0
mirror of https://github.com/DIYgod/RSSHub.git synced 2026-09-24 23:12:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: rename selfhost to configRequired

Browse Source
This commit is contained in:
DIYgod
2023-12-01 10:36:02 +08:00
parent 3dbb42f9af
commit 46300f5699
20 changed files with 84 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/docs/install/config.md
+1 -1
View File
@@ -235,7 +235,7 @@ Configs in this sections are in beta stage, and **are turn off by default**. Ple
`OPENAI_PROMPT`: OpenAI prompt, used for using ChatGPT to summarize articles, see [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat) for details
## Route-specific Configurations
## Route-specific Configurations {#route-specific-configurations}
:::tip
website/docs/joinus/new-rss/add-docs.md
+3 -3
View File
@@ -217,7 +217,7 @@ In addition to the aforementioned component properties, there are several other
- `puppeteer`: set to `1` if the feed uses puppeteer.
- `radar`: set to `1` if the feed has a radar rule.
- `rssbud`: set to `1` if the radar rule is also compatible with RSSBud
- `selfhost`: set to `1` if the feed requires extra configuration through environment variables.
- `configRequired`: set to `1` if the feed requires extra configuration through environment variables.
- `supportBT`: set to `1` if the feed supports BitTorrent.
- `supportPodcast`: set to `1` if the feed supports podcasts.
- `supportScihub`: set to `1` if the feed supports Sci-Hub.
@@ -225,12 +225,12 @@ In addition to the aforementioned component properties, there are several other
By using these properties, you can provide valuable information to users and make it easier for them to understand and use your route. Adding these properties to your route documentation will add a badge in front of it.
```tsx
<Route author="HenryQW" example="/github/issue/DIYgod/RSSHub" path="/github/issue/:user/:repo?" paramsDesc={['GitHub username', 'GitHub repo name, `RSSHub` by default']} anticrawler="1" puppeteer="1" radar="1" rssbud="1" selfhost="1" supportBT="1" supportPodcast="1" supportScihub="1" />
<Route author="HenryQW" example="/github/issue/DIYgod/RSSHub" path="/github/issue/:user/:repo?" paramsDesc={['GitHub username', 'GitHub repo name, `RSSHub` by default']} anticrawler="1" puppeteer="1" radar="1" rssbud="1" configRequired="1" supportBT="1" supportPodcast="1" supportScihub="1" />
```
---
<Route author="HenryQW" example="/github/issue/DIYgod/RSSHub" path="/github/issue/:user/:repo?" paramsDesc={['GitHub username', 'GitHub repo name, `RSSHub` by default']} anticrawler="1" puppeteer="1" radar="1" rssbud="1" selfhost="1" supportBT="1" supportPodcast="1" supportScihub="1" />
<Route author="HenryQW" example="/github/issue/DIYgod/RSSHub" path="/github/issue/:user/:repo?" paramsDesc={['GitHub username', 'GitHub repo name, `RSSHub` by default']} anticrawler="1" puppeteer="1" radar="1" rssbud="1" configRequired="1" supportBT="1" supportPodcast="1" supportScihub="1" />
---
website/docs/routes/anime.mdx
+2 -2
View File
@@ -354,7 +354,7 @@ If you subscribe to [Discounted works Latest Discounts - Newest to Oldest](https
### User Subscriptions {#iwara-user-subscriptions}
<Route author="FeCCC" example="/iwara/subscriptions" path="/iwara/subscriptions" radar="1" rssbud="1" selfhost="1">
<Route author="FeCCC" example="/iwara/subscriptions" path="/iwara/subscriptions" radar="1" rssbud="1" configRequired="1">
:::warning
@@ -795,7 +795,7 @@ You can use some RSS parsing libraries (like `feedpraser` in `Python`) to receiv
### 漫画个人订阅 {#kan-man-hua-man-hua-ge-ren-ding-yue}
<Route author="shininome" path="/manhuagui/subscribe" example="/manhuagui/subscribe" radar="1" rssbud="1" selfhost="1">
<Route author="shininome" path="/manhuagui/subscribe" example="/manhuagui/subscribe" radar="1" rssbud="1" configRequired="1">
:::tip
website/docs/routes/bbs.mdx
+3 -3
View File
@@ -217,11 +217,11 @@ You need to set the environment variable `DISCOURSE_CONFIG_{id}` before using it
### Latest posts {#discourse-latest-posts}
<Route author="dzx-dzx" example="/discourse/0/posts" path="/discourse/:configId/posts" paramsDesc={['Environment variable configuration id, see above']} selfhost="1"/>
<Route author="dzx-dzx" example="/discourse/0/posts" path="/discourse/:configId/posts" paramsDesc={['Environment variable configuration id, see above']} configRequired="1"/>
### Notifications {#discourse-notifications}
<Route author="dzx-dzx" example="/discourse/0/notifications" path="/discourse/:configId/notifications/:fulltext?" paramsDesc={['Environment variable configuration id, see above','Fetch the content if the notification points to a post. This is disabled by default, set it to `1` to enable it.']} selfhost="1"/>
<Route author="dzx-dzx" example="/discourse/0/notifications" path="/discourse/:configId/notifications/:fulltext?" paramsDesc={['Environment variable configuration id, see above','Fetch the content if the notification points to a post. This is disabled by default, set it to `1` to enable it.']} configRequired="1"/>
:::warning
@@ -503,7 +503,7 @@ When accessing Joeyray's Bar, `SCBOY_BBS_TOKEN` needs to be filled in `environme
### forum {#zodgame-forum}
<Route author="FeCCC" example="/zodgame/forum/13" path="/zodgame/forum/:fid?" paramsDesc={['forum id, can be found in URL']} radar="1" rssbud="1" selfhost="1"/>
<Route author="FeCCC" example="/zodgame/forum/13" path="/zodgame/forum/:fid?" paramsDesc={['forum id, can be found in URL']} radar="1" rssbud="1" configRequired="1"/>
## Zuvio {#zuvio}
website/docs/routes/blog.mdx
+6 -6
View File
@@ -118,15 +118,15 @@ username 为博主用户名，而非`xxx.hashnode.dev`中`xxx`所代表的 blog
### Blog using Next theme {#hexo-blog-using-next-theme}
<Route author="fengkx" path="/hexo/next/:url" example="/hexo/next/archive.diygod.me" paramsDesc={['the blog URL without the protocol (http:// and https://)']} selfhost="1"/>
<Route author="fengkx" path="/hexo/next/:url" example="/hexo/next/archive.diygod.me" paramsDesc={['the blog URL without the protocol (http:// and https://)']} configRequired="1"/>
### Blog using Yilia theme {#hexo-blog-using-yilia-theme}
<Route author="aha2mao" path="/hexo/yilia/:url" example="/hexo/yilia/cloudstone.xin" paramsDesc={['the blog URL without the protocol (http:// and https://)']} selfhost="1"/>
<Route author="aha2mao" path="/hexo/yilia/:url" example="/hexo/yilia/cloudstone.xin" paramsDesc={['the blog URL without the protocol (http:// and https://)']} configRequired="1"/>
### Blog using Fluid theme {#hexo-blog-using-fluid-theme}
<Route author="gkkeys" path="/hexo/fluid/:url" example="/hexo/fluid/blog.tonyzhao.xyz" paramsDesc={['the blog URL without the protocol (http:// and https://)']} selfhost="1"/>
<Route author="gkkeys" path="/hexo/fluid/:url" example="/hexo/fluid/blog.tonyzhao.xyz" paramsDesc={['the blog URL without the protocol (http:// and https://)']} configRequired="1"/>
## Hi, DIYgod {#hi-diygod}
@@ -204,7 +204,7 @@ To access private lists, only self-hosting is supported.
### Personalized Recommendations - For You {#medium-personalized-recommendations-for-you}
<Route author="ImSingee" example="/medium/for-you/imsingee" path="/medium/for-you/:user" paramsDesc={['Username']} selfhost="1">
<Route author="ImSingee" example="/medium/for-you/imsingee" path="/medium/for-you/:user" paramsDesc={['Username']} configRequired="1">
:::warning
@@ -216,7 +216,7 @@ Personalized recommendations require the cookie value after logging in, so only
### Personalized Recommendations - Following {#medium-personalized-recommendations-following}
<Route author="ImSingee" example="/medium/following/imsingee" path="/medium/following/:user" paramsDesc={['Username']} selfhost="1">
<Route author="ImSingee" example="/medium/following/imsingee" path="/medium/following/:user" paramsDesc={['Username']} configRequired="1">
:::warning
@@ -228,7 +228,7 @@ Personalized recommendations require the cookie value after logging in, so only
### Personalized Recommendations - Tag {#medium-personalized-recommendations-tag}
<Route author="ImSingee" example="/medium/tag/imsingee/cybersecurity" path="/medium/tag/:user/:tag" paramsDesc={['Username', 'Subscribed Tag']} selfhost="1">
<Route author="ImSingee" example="/medium/tag/imsingee/cybersecurity" path="/medium/tag/:user/:tag" paramsDesc={['Username', 'Subscribed Tag']} configRequired="1">
There are many tags, which can be obtained by clicking on a tag from the homepage and looking at the URL. For example, if the URL is `https://medium.com/?tag=web3`, then the tag is `web3`.
website/docs/routes/design.mdx
+1 -1
View File
@@ -76,7 +76,7 @@ Behance user's profile URL, like [https://www.behance.net/mishapetrick](https://
### Google Fonts {#google-google-fonts}
<Route author="Fatpandac" example="/google/fonts/date" path="/google/fonts/:sort?" paramsDesc={['Sorting type, see below, default to `date`']} selfhost="1">
<Route author="Fatpandac" example="/google/fonts/date" path="/google/fonts/:sort?" paramsDesc={['Sorting type, see below, default to `date`']} configRequired="1">
| Newest | Trending | Most popular | Name | Number of styles |
| :----: | :------: | :----------: | :--: | :--------------: |
website/docs/routes/forecast.mdx
+2 -2
View File
@@ -86,7 +86,7 @@ Please skip the local service area code for `name`, for example `https://outage.
### 近三天天气 {#he-feng-tian-qi-jin-san-tian-tian-qi}
<Route author="Rein-Ou" example="/qweather/3days/广州" path="/qweather/3days/:location" selfhost="1">
<Route author="Rein-Ou" example="/qweather/3days/广州" path="/qweather/3days/:location" configRequired="1">
需自行注册获取 api 的 key，并在环境变量 HEFENG_KEY 中进行配置，获取订阅近三天天气预报
@@ -94,7 +94,7 @@ Please skip the local service area code for `name`, for example `https://outage.
### 实时天气 {#he-feng-tian-qi-shi-shi-tian-qi}
<Route author="Rein-Ou" example="/qweather/广州" path="/qweather/now/:location" selfhost="1">
<Route author="Rein-Ou" example="/qweather/广州" path="/qweather/now/:location" configRequired="1">
需自行注册获取 api 的 key，每小时更新一次数据
website/docs/routes/multimedia.mdx
+12 -12
View File
@@ -1261,27 +1261,27 @@ Refer to [Pornhub F.A.Qs](https://help.pornhub.com/hc/en-us/articles/36004432703
### Artist Albums {#spotify-artist-albums}
<Route author="outloudvi" example="/spotify/artist/6k9TBCxyr4bXwZ8Y21Kwn1" path="/spotify/artist/:id" paramsDesc={['Artist ID']} selfhost="1"/>
<Route author="outloudvi" example="/spotify/artist/6k9TBCxyr4bXwZ8Y21Kwn1" path="/spotify/artist/:id" paramsDesc={['Artist ID']} configRequired="1"/>
### Playlist {#spotify-playlist}
<Route author="outloudvi" example="/spotify/playlist/4UBVy1LttvodwivPUuwJk2" path="/spotify/playlist/:id" paramsDesc={['Playlist ID']} selfhost="1"/>
<Route author="outloudvi" example="/spotify/playlist/4UBVy1LttvodwivPUuwJk2" path="/spotify/playlist/:id" paramsDesc={['Playlist ID']} configRequired="1"/>
### Personal Saved Tracks {#spotify-personal-saved-tracks}
<Route author="outloudvi" example="/spotify/saved/50" path="/spotify/saved/:limit?" paramsDesc={['Track count, 50 by default']} selfhost="1"/>
<Route author="outloudvi" example="/spotify/saved/50" path="/spotify/saved/:limit?" paramsDesc={['Track count, 50 by default']} configRequired="1"/>
### Personal Top Tracks {#spotify-personal-top-tracks}
<Route author="outloudvi" example="/spotify/top/tracks" path="/spotify/top/tracks" selfhost="1"/>
<Route author="outloudvi" example="/spotify/top/tracks" path="/spotify/top/tracks" configRequired="1"/>
### Personal Top Artists {#spotify-personal-top-artists}
<Route author="outloudvi" example="/spotify/top/artists" path="/spotify/top/artists" selfhost="1"/>
<Route author="outloudvi" example="/spotify/top/artists" path="/spotify/top/artists" configRequired="1"/>
### Show {#spotify-show}
<Route author="caiohsramos" example="/spotify/show/38bS44xjbVVZ3No3ByF1dJ" path="/spotify/show/:id" paramsDesc={['Show ID']} selfhost="1"/>
<Route author="caiohsramos" example="/spotify/show/38bS44xjbVVZ3No3ByF1dJ" path="/spotify/show/:id" paramsDesc={['Show ID']} configRequired="1"/>
## Sub HD {#sub-hd}
@@ -1651,7 +1651,7 @@ When `mediaType` is `movie`, `sheet` should be:
### 最新资源 {#pian-yuan-wang-zui-xin-zi-yuan}
<Route author="greatcodeeer jerry1119" example="/pianyuan/index" path="/pianyuan/index/:media?" paramsDesc={['类别，见下表，默认为首页']} radar="1" rssbud="1" selfhost="1"/>
<Route author="greatcodeeer jerry1119" example="/pianyuan/index" path="/pianyuan/index/:media?" paramsDesc={['类别，见下表，默认为首页']} radar="1" rssbud="1" configRequired="1"/>
| 电影 | 剧集 |
| ---- | ---- |
@@ -1659,7 +1659,7 @@ When `mediaType` is `movie`, `sheet` should be:
### 搜索 {#pian-yuan-wang-sou-suo}
<Route author="jerry1119" example="/pianyuan/indexers/pianyuan/results/search/api?t=test&q=长津湖" path="/pianyuan/indexers/pianyuan/results/search/" selfhost="1"/>
<Route author="jerry1119" example="/pianyuan/indexers/pianyuan/results/search/api?t=test&q=长津湖" path="/pianyuan/indexers/pianyuan/results/search/" configRequired="1"/>
搜索路由模仿 jackett 的搜索 api, 以提供给 nastools 使用，填写在 nastools 配置 indexer 中
@@ -1733,7 +1733,7 @@ When `mediaType` is `movie`, `sheet` should be:
### 作者文章 {#se-hua-tang-zuo-zhe-wen-zhang}
<Route author="JamYiz" example="/sehuatang/user/411096" path="/sehuatang/user/:uid" paramsDesc={['用户 uid, 可在用户主页 URL 中找到']} selfhost="1"/>
<Route author="JamYiz" example="/sehuatang/user/411096" path="/sehuatang/user/:uid" paramsDesc={['用户 uid, 可在用户主页 URL 中找到']} configRequired="1"/>
## 深影译站 {#shen-ying-yi-zhan}
@@ -1845,7 +1845,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性
### 专辑（不输出 ShowNote） {#xi-ma-la-ya-zhuan-ji-bu-shu-chu-shownote}
<Route author="lengthmin jjeejj prnake" example="/ximalaya/album/299146" path="/ximalaya/:type/:id/:all?" paramsDesc={['专辑类型, 通常可以使用 `album`，可在对应专辑页面的 URL 中找到','专辑 id, 可在对应专辑页面的 URL 中找到','是否需要获取全部节目，填入 `1`、`true`、`all` 视为获取所有节目，填入其他则不获取。']} supportPodcast="1" radar="1" rssbud="1" selfhost="1">
<Route author="lengthmin jjeejj prnake" example="/ximalaya/album/299146" path="/ximalaya/:type/:id/:all?" paramsDesc={['专辑类型, 通常可以使用 `album`，可在对应专辑页面的 URL 中找到','专辑 id, 可在对应专辑页面的 URL 中找到','是否需要获取全部节目，填入 `1`、`true`、`all` 视为获取所有节目，填入其他则不获取。']} supportPodcast="1" radar="1" rssbud="1" configRequired="1">
目前喜马拉雅的 API 只能一集一集的获取各节目上的 ShowNote，会极大的占用系统资源，所以默认为不获取节目的 ShowNote。下方有一个新的路径可选获取 ShowNote。
@@ -1861,7 +1861,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性
### 专辑（输出 ShowNote） {#xi-ma-la-ya-zhuan-ji-shu-chu-shownote}
<Route author="lengthmin jjeejj prnake" example="/ximalaya/album/39488639/0/shownote" path="/ximalaya/:type/:id/:all/:shownote?" paramsDesc={['专辑类型, 通常可以使用 `album`，可在对应专辑页面的 URL 中找到','专辑 id, 可在对应专辑页面的 URL 中找到','是否需要获取全部节目，填入 `1`、`true`、`all` 视为获取所有节目，填入其他则不获取。', '是否需要获取节目的 ShowNote，填入 `1`、`true`,`shownote` 视为获取，填入其他则不获取。']} supportPodcast="1" selfhost="1">
<Route author="lengthmin jjeejj prnake" example="/ximalaya/album/39488639/0/shownote" path="/ximalaya/:type/:id/:all/:shownote?" paramsDesc={['专辑类型, 通常可以使用 `album`，可在对应专辑页面的 URL 中找到','专辑 id, 可在对应专辑页面的 URL 中找到','是否需要获取全部节目，填入 `1`、`true`、`all` 视为获取所有节目，填入其他则不获取。', '是否需要获取节目的 ShowNote，填入 `1`、`true`,`shownote` 视为获取，填入其他则不获取。']} supportPodcast="1" configRequired="1">
</Route>
@@ -1869,7 +1869,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性
### 发现 {#xiao-yu-zhou-fa-xian}
<Route author="prnake" example="/xiaoyuzhou" path="/xiaoyuzhou" selfhost="1">
<Route author="prnake" example="/xiaoyuzhou" path="/xiaoyuzhou" configRequired="1">
:::warning
website/docs/routes/new-media.mdx
+1 -1
View File
@@ -5669,7 +5669,7 @@ column 为 third 时可选的 category:
### 公众号（微阅读来源） {#wei-xin-gong-zhong-hao-wei-yue-du-lai-yuan}
<Route author="Rongronggg9" example="/wechat/data258/gh_cbbad4c1d33c" path="/data258/:id?" paramsDesc={['公众号 id 或分类 id，可在公众号页或分类页 URL 中找到；若略去，则抓取首页']} anticrawler="1" radar="1" rssbud="1" selfhost="1">
<Route author="Rongronggg9" example="/wechat/data258/gh_cbbad4c1d33c" path="/data258/:id?" paramsDesc={['公众号 id 或分类 id，可在公众号页或分类页 URL 中找到；若略去，则抓取首页']} anticrawler="1" radar="1" rssbud="1" configRequired="1">
:::warning
website/docs/routes/other.mdx
+9 -9
View File
@@ -4,7 +4,7 @@
### 4399 论坛 {#4399-lun-tan-4399-lun-tan}
<Route author="DIYgod" example="/forum4399/mtag-83932" path="/forum4399/:mtag" paramsDesc={['mtag,必选-论坛网址最后的mtag字段']} selfhost="1">
<Route author="DIYgod" example="/forum4399/mtag-83932" path="/forum4399/:mtag" paramsDesc={['mtag,必选-论坛网址最后的mtag字段']} configRequired="1">
:::warning
@@ -219,7 +219,7 @@ Official Website: [https://news.yahoo.co.jp/pages/article/20200207](https://news
> Only support IMAP protocol, email password and other settings refer to [Email setting](/install)
<Route author="kt286" example="/mail/imap/rss@rsshub.app" path="/mail/imap/:email/:folder*" paramsDesc={['Email account', 'Inbox name, `INBOX` by default']} selfhost="1"/>
<Route author="kt286" example="/mail/imap/rss@rsshub.app" path="/mail/imap/:email/:folder*" paramsDesc={['Email account', 'Inbox name, `INBOX` by default']} configRequired="1"/>
## Emi Nitta official website 新田惠海官方网站 {#emi-nitta-official-website-xin-tian-hui-hai-guan-fang-wang-zhan}
@@ -393,7 +393,7 @@ For example:
### 订阅列表 {#miniflux-ding-yue-lie-biao}
<Route author="emdoe" example="/miniflux/subscription/categories=科技,影音" path="/miniflux/subscription/:parameters?" paramsDesc={['分类名或分类 ID 或/且 订阅源名称或订阅源 ID']} selfhost="1">
<Route author="emdoe" example="/miniflux/subscription/categories=科技,影音" path="/miniflux/subscription/:parameters?" paramsDesc={['分类名或分类 ID 或/且 订阅源名称或订阅源 ID']} configRequired="1">
1. 如无指定参数，默认输出全部订阅源
2. 分类 ID 或订阅源 ID 请于`分类`（快捷键 `g` `c`）或`源`（快捷键 `g` `f`）页面获取，每个分类（或订阅源）的网址即显示其 ID 信息。
@@ -405,7 +405,7 @@ For example:
### 获取订阅源内容 {#miniflux-huo-qu-ding-yue-yuan-nei-rong}
<Route author="emdoe" example="/miniflux/feeds=1&2&3/mark=read&limit=7&status=unread" path="/miniflux/:feeds/:parameters?" paramsDesc={['订阅源 ID 或获取全部', '过滤及设置参数，多个请用 `&` 连接']} selfhost="1">
<Route author="emdoe" example="/miniflux/feeds=1&2&3/mark=read&limit=7&status=unread" path="/miniflux/:feeds/:parameters?" paramsDesc={['订阅源 ID 或获取全部', '过滤及设置参数，多个请用 `&` 连接']} configRequired="1">
1. 支持获取全部内容：即可通过 `/miniflux/all` 或 `/miniflux/default` 等关键字获取全部订阅源下的内容。
2. 支持通过订阅源的 ID 获取指定订阅源的订阅内容，订阅源 ID 请于`源`（快捷键 `g` `f`）所在的页面获取，每个分类（或订阅源）的网址即显示其 ID 信息。而格式上有如下选择：
@@ -496,7 +496,7 @@ It is recommended to use with clipping tools such as Notion Web Clipper.
### Database {#notion-database}
<Route author="curly210102" example="/notion/database/a7cc133b68454f138011f1530a13531e" path="/notion/database/:databaseId" paramsDesc={['Database ID']} selfhost="1" radar="1">
<Route author="curly210102" example="/notion/database/a7cc133b68454f138011f1530a13531e" path="/notion/database/:databaseId" paramsDesc={['Database ID']} configRequired="1" radar="1">
There is an optional query parameter called `properties=` that can be used to customize field mapping. There are three built-in fields: author, pubTime and link, which can be used to add additional information.
@@ -596,7 +596,7 @@ Specify options (in the format of query string) in parameter `routeParams` param
| `itemPubDate` | The HTML elements as `pubDate` in `item` using CSS selector | `string` | `item` element |
| `itemPubDateAttr` | The attributes of `pubDate` element as pubDate | `string` | Element html |
<Route author="ttttmr" example="/rsshub/transform/html/https%3A%2F%2Fwechat2rss.xlab.app%2Fposts%2Flist%2F/item=div%5Bclass%3D%27post%2Dcontent%27%5D%20p%20a" path="/rsshub/transform/html/:url/:routeParams" paramsDesc={['`encodeURIComponent`ed URL address', 'Transformation rules, requires URL encode']} selfhost="1">
<Route author="ttttmr" example="/rsshub/transform/html/https%3A%2F%2Fwechat2rss.xlab.app%2Fposts%2Flist%2F/item=div%5Bclass%3D%27post%2Dcontent%27%5D%20p%20a" path="/rsshub/transform/html/:url/:routeParams" paramsDesc={['`encodeURIComponent`ed URL address', 'Transformation rules, requires URL encode']} configRequired="1">
Parameters parsing in the above example:
@@ -632,7 +632,7 @@ JSON Path only supports format like `a.b.c`. if you need to access arrays, like
:::
<Route author="ttttmr" example="/rsshub/transform/json/https%3A%2F%2Fapi.github.com%2Frepos%2Fginuerzh%2Fgost%2Freleases/title=Gost%20releases&itemTitle=tag_name&itemLink=html_url&itemDesc=body" path="/rsshub/transform/json/:url/:routeParams" paramsDesc={['`encodeURIComponent`ed URL address', 'Transformation rules, requires URL encode']} selfhost="1">
<Route author="ttttmr" example="/rsshub/transform/json/https%3A%2F%2Fapi.github.com%2Frepos%2Fginuerzh%2Fgost%2Freleases/title=Gost%20releases&itemTitle=tag_name&itemLink=html_url&itemDesc=body" path="/rsshub/transform/json/:url/:routeParams" paramsDesc={['`encodeURIComponent`ed URL address', 'Transformation rules, requires URL encode']} configRequired="1">
Parameters parsing in the above example:
@@ -660,7 +660,7 @@ Specify options (in the format of query string) in parameter `routeParams` param
|-----------------|----------------------------------------------------------------|-----------------|------------------------|
| `title` | The title of the RSS | `string` | Extract from `<title>` |
<Route author="flrngel" example="/rsshub/transform/xml/https%3A%2F%2Fwww.sitemaps.org%2Fsitemap.xml/" path="/rsshub/transform/html/:url/:routeParams?" paramsDesc={['`encodeURIComponent`ed URL address', 'Transformation rules, requires URL encode']} selfhost="1">
<Route author="flrngel" example="/rsshub/transform/xml/https%3A%2F%2Fwww.sitemaps.org%2Fsitemap.xml/" path="/rsshub/transform/html/:url/:routeParams?" paramsDesc={['`encodeURIComponent`ed URL address', 'Transformation rules, requires URL encode']} configRequired="1">
Parameters parsing in the above example:
@@ -851,7 +851,7 @@ Refer to [the list of supported currencies](https://wise.com/tools/exchange-rate
:::
<Route author="DIYgod" example="/dida365/habit/checkins" path="/dida365/habit/checkins" selfhost="1"/>
<Route author="DIYgod" example="/dida365/habit/checkins" path="/dida365/habit/checkins" configRequired="1"/>
## 福利资源 - met.red {#fu-li-zi-yuan-met.red}
website/docs/routes/picture.mdx
+1 -1
View File
@@ -471,7 +471,7 @@ For example:
### Search {#pixabay-search}
<Route author="TonyRL" example="/pixabay/search/cat" path="/pixabay/search/:q/:order?" paramsDesc={['Search term', 'Order, `popular` or `latest`, `latest` by default']} radar="1" selfhost="1"/>
<Route author="TonyRL" example="/pixabay/search/cat" path="/pixabay/search/:q/:order?" paramsDesc={['Search term', 'Order, `popular` or `latest`, `latest` by default']} radar="1" configRequired="1"/>
## Porn Image XXX {#porn-image-xxx}
website/docs/routes/programming.mdx
+2 -2
View File
@@ -310,7 +310,7 @@ GitHub provides some official RSS feeds:
### Trending {#github-trending}
<Route author="DIYgod" path="/github/trending/:since/:language/:spoken_language?" example="/github/trending/daily/javascript/en" paramsDesc={['time frame, available in [Trending page](https://github.com/trending/javascript?since=monthly) \'s URL, possible values are: `daily`, `weekly` or `monthly`', 'the feed language, available in [Trending page](https://github.com/trending/javascript?since=monthly) \'s URL, don\'t filter option is `any`', 'natural language, available in [Trending page](https://github.com/trending/javascript?since=monthly) \'s URL']} radar="1" rssbud="1" selfhost="1"/>
<Route author="DIYgod" path="/github/trending/:since/:language/:spoken_language?" example="/github/trending/daily/javascript/en" paramsDesc={['time frame, available in [Trending page](https://github.com/trending/javascript?since=monthly) \'s URL, possible values are: `daily`, `weekly` or `monthly`', 'the feed language, available in [Trending page](https://github.com/trending/javascript?since=monthly) \'s URL, don\'t filter option is `any`', 'natural language, available in [Trending page](https://github.com/trending/javascript?since=monthly) \'s URL']} radar="1" rssbud="1" configRequired="1"/>
### Topics {#github-topics}
@@ -399,7 +399,7 @@ For instance, the `/github/topics/framework/l=php&o=desc&s=stars` route will gen
### Notifications {#github-notifications}
<Route author="zhzy0077" example="/github/notifications" path="/github/notifications" radar="1" rssbud="1" selfhost="1"/>
<Route author="zhzy0077" example="/github/notifications" path="/github/notifications" radar="1" rssbud="1" configRequired="1"/>
### Gist Commits {#github-gist-commits}
website/docs/routes/reading.mdx
+1 -1
View File
@@ -497,7 +497,7 @@ count 的取值范围为 1-12，为防止请求次数过多，推荐设置为 5
### 首页分类 {#qing-xiao-shuo-wen-ku-shou-ye-fen-lei}
<Route author="Fatpandac" example="/wenku8/lastupdate" path="/wenku8/:categoty?" paramsDesc={['首页分类，见下表，默认为今日更新']} selfhost="1">
<Route author="Fatpandac" example="/wenku8/lastupdate" path="/wenku8/:categoty?" paramsDesc={['首页分类，见下表，默认为今日更新']} configRequired="1">
:::warning
website/docs/routes/social-media.mdx
+23 -23
View File
@@ -85,7 +85,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性
### UP 主粉丝 {#bilibili-up-zhu-fen-si}
<Route author="Qixingchen" example="/bilibili/user/followers/2267573/3" path="/bilibili/user/followers/:uid/:loginUid" paramsDesc={['用户 id, 可在 UP 主主页中找到','用于登入的用户id,需要配置对应的 Cookie 值']} radar="1" rssbud="1" selfhost="1">
<Route author="Qixingchen" example="/bilibili/user/followers/2267573/3" path="/bilibili/user/followers/:uid/:loginUid" paramsDesc={['用户 id, 可在 UP 主主页中找到','用于登入的用户id,需要配置对应的 Cookie 值']} radar="1" rssbud="1" configRequired="1">
:::warning
@@ -97,7 +97,7 @@ UP 主粉丝现在需要 b 站登录后的 Cookie 值，所以只能自建，详
### UP 主关注用户 {#bilibili-up-zhu-guan-zhu-yong-hu}
<Route author="Qixingchen" example="/bilibili/user/followings/2267573/3" path="/bilibili/user/followings/:uid/:loginUid" paramsDesc={['用户 id, 可在 UP 主主页中找到','用于登入的用户id,需要配置对应的 Cookie 值']} radar="1" rssbud="1" selfhost="1">
<Route author="Qixingchen" example="/bilibili/user/followings/2267573/3" path="/bilibili/user/followings/:uid/:loginUid" paramsDesc={['用户 id, 可在 UP 主主页中找到','用于登入的用户id,需要配置对应的 Cookie 值']} radar="1" rssbud="1" configRequired="1">
:::warning
@@ -265,7 +265,7 @@ UP 主关注用户现在需要 b 站登录后的 Cookie 值，所以只能自建
### 用户关注动态 {#bilibili-yong-hu-guan-zhu-dong-tai}
<Route author="TigerCubDen JimenezLi" example="/bilibili/followings/dynamic/109937383" path="/bilibili/followings/dynamic/:uid/:routeParams?" paramsDesc={['用户 id', '额外参数；请参阅 [#UP 主动态](#bilibili-up-zhu-dong-tai) 的说明和表格']} selfhost="1">
<Route author="TigerCubDen JimenezLi" example="/bilibili/followings/dynamic/109937383" path="/bilibili/followings/dynamic/:uid/:routeParams?" paramsDesc={['用户 id', '额外参数；请参阅 [#UP 主动态](#bilibili-up-zhu-dong-tai) 的说明和表格']} configRequired="1">
:::warning
@@ -277,7 +277,7 @@ UP 主关注用户现在需要 b 站登录后的 Cookie 值，所以只能自建
### 用户关注视频动态 {#bilibili-yong-hu-guan-zhu-shi-pin-dong-tai}
<Route author="LogicJake" example="/bilibili/followings/video/2267573" path="/bilibili/followings/video/:uid/:disableEmbed?" paramsDesc={['用户 id', '默认为开启内嵌视频, 任意值为关闭']} selfhost="1">
<Route author="LogicJake" example="/bilibili/followings/video/2267573" path="/bilibili/followings/video/:uid/:disableEmbed?" paramsDesc={['用户 id', '默认为开启内嵌视频, 任意值为关闭']} configRequired="1">
:::warning
@@ -289,7 +289,7 @@ UP 主关注用户现在需要 b 站登录后的 Cookie 值，所以只能自建
### 用户关注专栏 {#bilibili-yong-hu-guan-zhu-zhuan-lan}
<Route author="woshiluo" example="/bilibili/followings/article/99800931" path="/bilibili/followings/article/:uid" paramsDesc={['用户 id']} selfhost="1">
<Route author="woshiluo" example="/bilibili/followings/article/99800931" path="/bilibili/followings/article/:uid" paramsDesc={['用户 id']} configRequired="1">
:::warning
@@ -301,7 +301,7 @@ UP 主关注用户现在需要 b 站登录后的 Cookie 值，所以只能自建
### 用户稍后再看 {#bilibili-yong-hu-shao-hou-zai-kan}
<Route author="JimenezLi" example="/bilibili/watchlater/2267573" path="/bilibili/watchlater/:uid/:disableEmbed?" paramsDesc={['用户 id', '默认为开启内嵌视频, 任意值为关闭']} selfhost="1">
<Route author="JimenezLi" example="/bilibili/watchlater/2267573" path="/bilibili/watchlater/:uid/:disableEmbed?" paramsDesc={['用户 id', '默认为开启内嵌视频, 任意值为关闭']} configRequired="1">
:::warning
@@ -391,7 +391,7 @@ UP 主关注用户现在需要 b 站登录后的 Cookie 值，所以只能自建
### 用户追漫更新 {#bilibili-yong-hu-zhui-man-geng-xin}
<Route author="yindaheng98" example="/bilibili/manga/followings/26009" path="/bilibili/manga/followings/:uid/:limits?" paramsDesc={['用户 id', '抓取最近更新前多少本漫画，默认为10']} selfhost="1">
<Route author="yindaheng98" example="/bilibili/manga/followings/26009" path="/bilibili/manga/followings/:uid/:limits?" paramsDesc={['用户 id', '抓取最近更新前多少本漫画，默认为10']} configRequired="1">
:::warning
@@ -471,7 +471,7 @@ UP 主关注用户现在需要 b 站登录后的 Cookie 值，所以只能自建
### Channel Messages {#discord-channel-messages}
<Route author="TonyRL" path="/discord/channel/:channelId" example="/discord/channel/950465850056536084" paramsDesc={['Channel ID']} radar="1" selfhost="1"/>
<Route author="TonyRL" path="/discord/channel/:channelId" example="/discord/channel/950465850056536084" paramsDesc={['Channel ID']} radar="1" configRequired="1"/>
## Disqus {#disqus}
@@ -607,7 +607,7 @@ Due to [Instagram Private API](https://github.com/dilame/instagram-private-api)
:::
<Route author="oppilate DIYgod" example="/instagram/user/stefaniejoosten" path="/instagram/:category/:key" paramsDesc={['Feed category, see table above','Username / Hashtag name']} radar="1" anticrawler="1" selfhost="1" />
<Route author="oppilate DIYgod" example="/instagram/user/stefaniejoosten" path="/instagram/:category/:key" paramsDesc={['Feed category, see table above','Username / Hashtag name']} radar="1" anticrawler="1" configRequired="1" />
## Keep {#keep}
@@ -619,7 +619,7 @@ Due to [Instagram Private API](https://github.com/dilame/instagram-private-api)
### Community {#lemmy-community}
<Route author="wb14123" example="/lemmy/technology@lemmy.world/Hot" path="/lemmy/:community/:sort?" paramsDesc={['Lemmmy community, for example technology@lemmy.world', 'Sort by, defaut to Active']} selfhost="1"/>
<Route author="wb14123" example="/lemmy/technology@lemmy.world/Hot" path="/lemmy/:community/:sort?" paramsDesc={['Lemmmy community, for example technology@lemmy.world', 'Sort by, defaut to Active']} configRequired="1"/>
## Lofter {#lofter}
@@ -759,7 +759,7 @@ Though, every Story expires after 24 hours, so it may be not so serious.
### Following timeline {#pixiv-following-timeline}
<Route author="ClarkeCheng" example="/pixiv/user/illustfollows" path="/pixiv/user/illustfollows" radar="1" rssbud="1" selfhost="1">
<Route author="ClarkeCheng" example="/pixiv/user/illustfollows" path="/pixiv/user/illustfollows" radar="1" rssbud="1" configRequired="1">
:::warning
@@ -976,23 +976,23 @@ generates
### User timeline {#twitter-user-timeline}
<Route author="DIYgod yindaheng98 Rongronggg9" path="/twitter/user/:id/:routeParams?" example="/twitter/user/DIYgod" paramsDesc={['username; in particular, if starts with `+`, it will be recognized as a [unique ID](https://github.com/DIYgod/RSSHub/issues/12221), e.g. `+44196397`', 'extra parameters, see the table above; particularly when `routeParams=exclude_replies`, replies are excluded; `routeParams=exclude_rts` excludes retweets,`routeParams=exclude_rts_replies` exclude replies and retweets; for default include all.']} radar="1" rssbud="1" selfhost="1"/>
<Route author="DIYgod yindaheng98 Rongronggg9" path="/twitter/user/:id/:routeParams?" example="/twitter/user/DIYgod" paramsDesc={['username; in particular, if starts with `+`, it will be recognized as a [unique ID](https://github.com/DIYgod/RSSHub/issues/12221), e.g. `+44196397`', 'extra parameters, see the table above; particularly when `routeParams=exclude_replies`, replies are excluded; `routeParams=exclude_rts` excludes retweets,`routeParams=exclude_rts_replies` exclude replies and retweets; for default include all.']} radar="1" rssbud="1" configRequired="1"/>
### User media {#twitter-user-media}
<Route author="yindaheng98 Rongronggg9 DIYgod" path="/twitter/media/:id/:routeParams?" example="/twitter/media/DIYgod" paramsDesc={['username; in particular, if starts with `+`, it will be recognized as a [unique ID](https://github.com/DIYgod/RSSHub/issues/12221), e.g. `+44196397`', 'extra parameters, see the table above.']} radar="1" rssbud="1" selfhost="1"/>
<Route author="yindaheng98 Rongronggg9 DIYgod" path="/twitter/media/:id/:routeParams?" example="/twitter/media/DIYgod" paramsDesc={['username; in particular, if starts with `+`, it will be recognized as a [unique ID](https://github.com/DIYgod/RSSHub/issues/12221), e.g. `+44196397`', 'extra parameters, see the table above.']} radar="1" rssbud="1" configRequired="1"/>
### Keyword {#twitter-keyword}
<Route author="DIYgod yindaheng98 Rongronggg9" example="/twitter/keyword/RSSHub" path="/twitter/keyword/:keyword/:routeParams?" paramsDesc={['keyword', 'extra parameters, see the table above']} radar="1" rssbud="1" selfhost="1"/>
<Route author="DIYgod yindaheng98 Rongronggg9" example="/twitter/keyword/RSSHub" path="/twitter/keyword/:keyword/:routeParams?" paramsDesc={['keyword', 'extra parameters, see the table above']} radar="1" rssbud="1" configRequired="1"/>
### Tweet Details {#twitter-tweet-details}
<Route author="LarchLiu Rongronggg9 DIYgod" example="/twitter/tweet/DIYgod/status/1650844643997646852" path="/twitter/tweet/:id/status/:status/:original?" paramsDesc={['username; in particular, if starts with `+`, it will be recognized as a [unique ID](https://github.com/DIYgod/RSSHub/issues/12221), e.g. `+44196397`', 'tweet ID', 'extra parameters, data type of return, if the value is not `0`/`false` and `config.isPackage` is `true`, return the original data of twitter']} radar="1" rssbud="1" selfhost="1"/>
<Route author="LarchLiu Rongronggg9 DIYgod" example="/twitter/tweet/DIYgod/status/1650844643997646852" path="/twitter/tweet/:id/status/:status/:original?" paramsDesc={['username; in particular, if starts with `+`, it will be recognized as a [unique ID](https://github.com/DIYgod/RSSHub/issues/12221), e.g. `+44196397`', 'tweet ID', 'extra parameters, data type of return, if the value is not `0`/`false` and `config.isPackage` is `true`, return the original data of twitter']} radar="1" rssbud="1" configRequired="1"/>
### User following timeline {#twitter-user-following-timeline}
<Route author="DIYgod" example="/twitter/followings/DIYgod" path="/twitter/followings/:id/:routeParams?" paramsDesc={['username', 'extra parameters, see the table above']} radar="1" rssbud="1" selfhost="1">
<Route author="DIYgod" example="/twitter/followings/DIYgod" path="/twitter/followings/:id/:routeParams?" paramsDesc={['username', 'extra parameters, see the table above']} radar="1" rssbud="1" configRequired="1">
:::warning
@@ -1016,7 +1016,7 @@ This route requires Twitter token's corresponding id, therefore it's only availa
### Collection {#twitter-collection}
<Route author="TonyRL" example="/twitter/collection/DIYgod/1527857429467172864" path="/twitter/collection/:uid/:collectionId/:routeParams?" paramsDesc={['username, should match the generated token', 'collection ID, can be found in URL', 'extra parameters, see the table above']} radar="1" rssbud="1" selfhost="1">
<Route author="TonyRL" example="/twitter/collection/DIYgod/1527857429467172864" path="/twitter/collection/:uid/:collectionId/:routeParams?" paramsDesc={['username, should match the generated token', 'collection ID, can be found in URL', 'extra parameters, see the table above']} radar="1" rssbud="1" configRequired="1">
:::warning
@@ -1090,7 +1090,7 @@ YouTube provides official RSS feeds for channels, for instance [https://www.yout
### Subscriptions {#youtube-subscriptions}
<Route author="TonyRL" path="/youtube/subscriptions/:embed?" example="/youtube/subscriptions" paramsDesc={['Default to embed the video, set to any value to disable embedding']} selfhost="1" radar="1" rssbud="1"/>
<Route author="TonyRL" path="/youtube/subscriptions/:embed?" example="/youtube/subscriptions" paramsDesc={['Default to embed the video, set to any value to disable embedding']} configRequired="1" radar="1" rssbud="1"/>
### Music Charts {#youtube-music-charts}
@@ -1760,7 +1760,7 @@ rule
### 个人时间线 {#wei-bo-ge-ren-shi-jian-xian}
<Route author="zytomorrow DIYgod Rongronggg9" example="/weibo/timeline/3306934123" path="/weibo/timeline/:uid/:feature?/:routeParams?" paramsDesc={['用户的uid', '过滤类型ID，0：全部、1：原创、2：图片、3：视频、4：音乐，默认为0。', '额外参数；请参阅上面的说明和表格']} anticrawler="1" selfhost="1">
<Route author="zytomorrow DIYgod Rongronggg9" example="/weibo/timeline/3306934123" path="/weibo/timeline/:uid/:feature?/:routeParams?" paramsDesc={['用户的uid', '过滤类型ID，0：全部、1：原创、2：图片、3：视频、4：音乐，默认为0。', '额外参数；请参阅上面的说明和表格']} anticrawler="1" configRequired="1">
:::warning
@@ -1774,7 +1774,7 @@ rule
### 自定义分组 {#wei-bo-zi-ding-yi-fen-zu}
<Route author="monologconnor Rongronggg9" example="/weibo/group/4541216424989965/微博分组/:routeParams?" path="/weibo/group/:gid/:gname?/:routeParams?" paramsDesc={['分组id, 在网页版分组地址栏末尾`?gid=`处获取', '分组显示名称; 默认为: `微博分组`', '额外参数；请参阅上面的说明和表格']} anticrawler="1" selfhost="1">
<Route author="monologconnor Rongronggg9" example="/weibo/group/4541216424989965/微博分组/:routeParams?" path="/weibo/group/:gid/:gname?/:routeParams?" paramsDesc={['分组id, 在网页版分组地址栏末尾`?gid=`处获取', '分组显示名称; 默认为: `微博分组`', '额外参数；请参阅上面的说明和表格']} anticrawler="1" configRequired="1">
:::warning
@@ -1841,11 +1841,11 @@ rule
### 微信公众号 {#xin-bang-wei-xin-gong-zhong-hao}
<Route author="lessmoe" example="/newrank/wechat/chijiread" path="/newrank/wechat/:wxid" paramsDesc={['微信号，若微信号与新榜信息不一致，以新榜为准']} anticrawler="1" selfhost="1"/>
<Route author="lessmoe" example="/newrank/wechat/chijiread" path="/newrank/wechat/:wxid" paramsDesc={['微信号，若微信号与新榜信息不一致，以新榜为准']} anticrawler="1" configRequired="1"/>
### 抖音短视频 {#xin-bang-dou-yin-duan-shi-pin}
<Route author="lessmoe" example="/newrank/douyin/110266463747" path="/newrank/douyin/:dyid" paramsDesc={['抖音ID，可在新榜账号详情 URL 中找到']} anticrawler="1" selfhost="1"/>
<Route author="lessmoe" example="/newrank/douyin/110266463747" path="/newrank/douyin/:dyid" paramsDesc={['抖音ID，可在新榜账号详情 URL 中找到']} anticrawler="1" configRequired="1"/>
:::warning
@@ -1931,7 +1931,7 @@ rule
### 用户关注时间线 {#zhi-hu-yong-hu-guan-zhu-shi-jian-xian}
<Route author="SeanChao" example="/zhihu/timeline" path="/zhihu/timeline" anticrawler="1" selfhost="1">
<Route author="SeanChao" example="/zhihu/timeline" path="/zhihu/timeline" anticrawler="1" configRequired="1">
:::warning
website/docs/routes/university.mdx
+2 -2
View File
@@ -555,7 +555,7 @@ Note：[Source website](https://ece.umass.edu/seminar) may be empty when there's
### BTBYR 趣味盒 {#bei-jing-you-dian-da-xue-btbyr-qu-wei-he}
<Route author="prnake" example="/bupt/funbox" path="/bupt/funbox" selfhost="1"/>
<Route author="prnake" example="/bupt/funbox" path="/bupt/funbox" configRequired="1"/>
:::warning
@@ -3885,7 +3885,7 @@ jsjxy.hbut.edu.cn 证书链不全，自建 RSSHub 可设置环境变量 NODE_TLS
### 选课信息教务通知 {#zhong-guo-hai-yang-da-xue-xuan-ke-xin-xi-jiao-wu-tong-zhi}
<Route author="3401797899" example="/ouc/jwgl" path="/ouc/jwgl" radar="1" selfhost="1">
<Route author="3401797899" example="/ouc/jwgl" path="/ouc/jwgl" radar="1" configRequired="1">
:::warning
website/i18n/en/code.json
+3 -3
View File
@@ -14,15 +14,15 @@
"badge.anticrawler": {
"message": "Strict anti-crawler policy"
},
"badge.selfhost": {
"message": "Self-host only"
},
"badge.radar": {
"message": "Support browser extension"
},
"badge.rssbud": {
"message": "Support RSSBud"
},
"badge.configRequired": {
"message": "Config required"
},
"route.author": {
"message": "Author: "
},
website/i18n/zh/code.json
+3 -3
View File
@@ -14,15 +14,15 @@
"badge.anticrawler": {
"message": "反爬严格"
},
"badge.selfhost": {
"message": "仅支持自建"
},
"badge.radar": {
"message": "支持浏览器扩展"
},
"badge.rssbud": {
"message": "支持 RSSBud"
},
"badge.configRequired": {
"message": "需要配置"
},
"route.author": {
"message": "作者："
},
website/i18n/zh/docusaurus-plugin-content-docs/current/install/config.md
+1 -1
View File
@@ -235,7 +235,7 @@ RSSHub 支持使用访问密钥 / 码，允许清单和拒绝清单三种方式
`OPENAI_PROMPT`: OpenAI 提示语，用于使用 ChatGPT 总结文章，详见 [OpenAI API 文档](https://platform.openai.com/docs/api-reference/chat)
## 部分 RSS 模块配置
## 部分 RSS 模块配置 {#route-specific-configurations}
:::tip
website/i18n/zh/docusaurus-plugin-content-docs/current/joinus/new-rss/add-docs.md
+3 -3
View File
@@ -226,7 +226,7 @@ pnpm run start
- `puppeteer`：如果源使用 puppeteer 抓取，则设置为 `1`。
- `radar`：如果此源有相应的 Radar 规则，则设置为 `1`。
- `rssbud`：如果 Radar 规则与 RSSBud 兼容，则设置为 `1`。
- `selfhost`：如果 RSS 源需要通过环境变量进行额外配置，则设置为 `1`。
- `configRequired`：如果 RSS 源需要通过环境变量进行额外配置，则设置为 `1`。
- `supportBT`：如果支持被 BitTorrent 客户端识别，则设置为 `1`。
- `supportPodcast`：如果源支持播客，则设置为 `1`。
- `supportScihub`：如果源支持 Sci-Hub，则设置为 `1`。
@@ -234,12 +234,12 @@ pnpm run start
通过添加这些属性，您可以向用户提供有用的信息，并使其更易于理解和使用您的路由。将这些属性添加到路由文档中将在其前面添加一个徽章。
```tsx
<Route author="HenryQW" example="/github/issue/DIYgod/RSSHub" path="/github/issue/:user/:repo?" paramsDesc={['GitHub 用户名', 'GitHub 仓库名称，默认为 `RSSHub`']} anticrawler="1" puppeteer="1" radar="1" rssbud="1" selfhost="1" supportBT="1" supportPodcast="1" supportScihub="1" />
<Route author="HenryQW" example="/github/issue/DIYgod/RSSHub" path="/github/issue/:user/:repo?" paramsDesc={['GitHub 用户名', 'GitHub 仓库名称，默认为 `RSSHub`']} anticrawler="1" puppeteer="1" radar="1" rssbud="1" configRequired="1" supportBT="1" supportPodcast="1" supportScihub="1" />
```
---
<Route author="HenryQW" example="/github/issue/DIYgod/RSSHub" path="/github/issue/:user/:repo?" paramsDesc={['GitHub 用户名', 'GitHub 仓库名称，默认为 `RSSHub`']} anticrawler="1" puppeteer="1" radar="1" rssbud="1" selfhost="1" supportBT="1" supportPodcast="1" supportScihub="1" />
<Route author="HenryQW" example="/github/issue/DIYgod/RSSHub" path="/github/issue/:user/:repo?" paramsDesc={['GitHub 用户名', 'GitHub 仓库名称，默认为 `RSSHub`']} anticrawler="1" puppeteer="1" radar="1" rssbud="1" configRequired="1" supportBT="1" supportPodcast="1" supportScihub="1" />
---
website/src/components/Route.tsx
+5 -5
View File
@@ -14,7 +14,7 @@ export default function Route({
supportScihub = null,
radar = null,
rssbud = null,
selfhost = null,
configRequired = null,
puppeteer = null,
children = null,
}: {
@@ -28,7 +28,7 @@ export default function Route({
supportScihub?: boolean;
radar?: boolean;
rssbud?: boolean;
selfhost?: boolean;
configRequired?: boolean;
puppeteer?: boolean;
children?: JSX.Element | JSX.Element[];
}): JSX.Element {
@@ -54,9 +54,9 @@ export default function Route({
<Badge type="warn"><Translate id="badge.anticrawler" /></Badge>
</Link>
)}
{selfhost && (
<Link to="/install">
<Badge type="warn"><Translate id="badge.selfhost" /></Badge>
{configRequired && (
<Link to="/install/config#route-specific-configurations">
<Badge type="warn"><Translate id="badge.configRequired" /></Badge>
</Link>
)}
{radar && (