Skip to content

Commit

Permalink
docs: remove rssbud badge
Browse files Browse the repository at this point in the history
  • Loading branch information
@DIYgod
DIYgod committed Dec 1, 2023
1 parent 6ec4736 commit a975237
Show file tree
Hide file tree
Showing 27 changed files with 585 additions and 594 deletions.
2 changes: 1 addition & 1 deletion website/docs/joinus/new-radar.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ Both the above examples will return the same RSSHub subscription address as the

### Update the Documentation

As mentioned earlier in [Other components](/joinus/new-rss/add-docs#documentation-examples-other-components), adding `radar="1"` in the RSSHub docs will show a `Support browser extension` badge. If the rule is also compatible with RSSBud, adding `rssbud="1"` will show a `Support RSSBud` badge.
As mentioned earlier in [Other components](/joinus/new-rss/add-docs#documentation-examples-other-components), adding `radar="1"` in the RSSHub docs will show a `Support Radar` badge.

## Debugging Radar Rules

Expand Down
5 changes: 2 additions & 3 deletions website/docs/joinus/new-rss/add-docs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,6 @@ In addition to the aforementioned component properties, there are several other
- `anticrawler`: set to `1` if the target website has an anti-crawler mechanism.
- `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
- `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.
Expand All @@ -225,12 +224,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" 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" 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" 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" configRequired="1" supportBT="1" supportPodcast="1" supportScihub="1" />

---

Expand Down
62 changes: 31 additions & 31 deletions website/docs/routes/anime.mdx
View file

Large diffs are not rendered by default.

42 changes: 21 additions & 21 deletions website/docs/routes/bbs.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@

### 列表 {#8264-lie-biao}

<Route author="nczitzk" example="/8264/list/751" path="/8264/list/:id?" paramsDesc={['列表 id，见下表，默认为 751，即热门推荐']} radar="1" rssbud="1">
<Route author="nczitzk" example="/8264/list/751" path="/8264/list/:id?" paramsDesc={['列表 id，见下表，默认为 751，即热门推荐']} radar="1">

| 热门推荐 | 户外知识 | 户外装备 |
| -------- | -------- | -------- |
Expand Down Expand Up @@ -201,11 +201,11 @@

### 首頁帖子 {#dcard-shou-ye-tie-zi}

<Route author="DIYgod" example="/dcard/posts/popular" path="/dcard/posts/:type?" paramsDesc={['排序，popular 熱門；latest 最新，默認為 latest']} radar="1" rssbud="1" anticrawler="1" puppeteer="1"/>
<Route author="DIYgod" example="/dcard/posts/popular" path="/dcard/posts/:type?" paramsDesc={['排序，popular 熱門；latest 最新，默認為 latest']} radar="1" anticrawler="1" puppeteer="1"/>

### 板塊帖子 {#dcard-ban-kuai-tie-zi}

<Route author="HenryQW" example="/dcard/funny/popular" path="/dcard/:section/:type?" paramsDesc={['板塊名稱，URL 中獲得', '排序，popular 熱門；latest 最新，默認為 latest']} radar="1" rssbud="1" anticrawler="1" puppeteer="1"/>
<Route author="HenryQW" example="/dcard/funny/popular" path="/dcard/:section/:type?" paramsDesc={['板塊名稱，URL 中獲得', '排序，popular 熱門；latest 最新，默認為 latest']} radar="1" anticrawler="1" puppeteer="1"/>

## Discourse {#discourse}

Expand Down Expand Up @@ -271,13 +271,13 @@ If you opt to enable `fulltext` feature, consider adding `limit` parameter to yo

### 主题贴 {#etoland-zhu-ti-tie}

<Route author="mengx8" example="/etoland/star01" path="/etoland/:boardId" paramsDesc={['板块 id，可在板块 URL 找到']} radar="1" rssbud="1"/>
<Route author="mengx8" example="/etoland/star01" path="/etoland/:boardId" paramsDesc={['板块 id，可在板块 URL 找到']} radar="1"/>

## HACKER TALK 黑客说 {#hacker-talk-hei-ke-shuo}

### 最新帖子 {#hacker-talk-hei-ke-shuo-zui-xin-tie-zi}

<Route author="hyoban" example="/hackertalk" path="/hackertalk" radar="1" rssbud="1"/>
<Route author="hyoban" example="/hackertalk" path="/hackertalk" radar="1"/>

## LearnKu {#learnku}

Expand Down Expand Up @@ -309,11 +309,11 @@ If you opt to enable `fulltext` feature, consider adding `limit` parameter to yo

### 看板 {#meteor-kan-ban}

<Route author="TonyRL" example="/meteor/all" path="/meteor/:board?" paramsDesc={['看板 ID 或簡稱，可在 URL 或下方路由找到，預設為 `all`']} radar="1" rssbud="1"/>
<Route author="TonyRL" example="/meteor/all" path="/meteor/:board?" paramsDesc={['看板 ID 或簡稱，可在 URL 或下方路由找到，預設為 `all`']} radar="1"/>

### 看板列表 {#meteor-kan-ban-lie-biao}

<Route author="TonyRL" example="/meteor/boards" path="/meteor/boards" radar="1" rssbud="1"/>
<Route author="TonyRL" example="/meteor/boards" path="/meteor/boards" radar="1"/>

## Mobilism {#mobilism}

Expand Down Expand Up @@ -345,25 +345,25 @@ If you opt to enable `fulltext` feature, consider adding `limit` parameter to yo

### 分区帖子 {#nga-fen-qu-tie-zi}

<Route author="xyqfer" example="/nga/forum/489" path="/nga/forum/:fid/:recommend?" paramsDesc={['分区 id, 可在分区主页 URL 找到, 没有 fid 时 stid 同样适用','是否只显示精华主题, 留空为否, 任意值为是']} radar="1" rssbud="1"/>
<Route author="xyqfer" example="/nga/forum/489" path="/nga/forum/:fid/:recommend?" paramsDesc={['分区 id, 可在分区主页 URL 找到, 没有 fid 时 stid 同样适用','是否只显示精华主题, 留空为否, 任意值为是']} radar="1"/>

### 帖子 {#nga-tie-zi}

<Route author="xyqfer syrinka" example="/nga/post/18449558" path="/nga/post/:tid/:authorId?" paramsDesc={['帖子 id, 可在帖子 URL 找到', '作者 id']} radar="1" rssbud="1"/>
<Route author="xyqfer syrinka" example="/nga/post/18449558" path="/nga/post/:tid/:authorId?" paramsDesc={['帖子 id, 可在帖子 URL 找到', '作者 id']} radar="1"/>

## Pikabu {#pikabu}

### Community {#pikabu-community}

<Route author="TonyRL" example="/pikabu/community/real_true_story" path="/pikabu/community/:name" paramsDesc={['Community name']} radar="1" rssbud="1"/>
<Route author="TonyRL" example="/pikabu/community/real_true_story" path="/pikabu/community/:name" paramsDesc={['Community name']} radar="1"/>

### Tag {#pikabu-tag}

<Route author="TonyRL" example="/pikabu/tag/Metallica" path="/pikabu/tag/:name" paramsDesc={['Tag name']} radar="1" rssbud="1"/>
<Route author="TonyRL" example="/pikabu/tag/Metallica" path="/pikabu/tag/:name" paramsDesc={['Tag name']} radar="1"/>

### User {#pikabu-user}

<Route author="TonyRL" example="/pikabu/user/@Eujenu" path="/pikabu/user/:name" paramsDesc={['User name']} radar="1" rssbud="1"/>
<Route author="TonyRL" example="/pikabu/user/@Eujenu" path="/pikabu/user/:name" paramsDesc={['User name']} radar="1"/>

## PLAYNO.1 玩樂達人 {#playno.1-wan-le-da-ren}

Expand All @@ -375,7 +375,7 @@ If you opt to enable `fulltext` feature, consider adding `limit` parameter to yo

:::

<Route author="TonyRL" example="/playno1/av" path="/playno1/av/:catid?" paramsDesc={['分类，见下表，默认为全部文章']} radar="1" rssbud="1">
<Route author="TonyRL" example="/playno1/av" path="/playno1/av/:catid?" paramsDesc={['分类，见下表，默认为全部文章']} radar="1">

| 全部文章 | AV 新聞 | AV 導覽 |
| -------- | ------- | ------- |
Expand All @@ -385,7 +385,7 @@ If you opt to enable `fulltext` feature, consider adding `limit` parameter to yo

### 情趣 {#playno.1-wan-le-da-ren-qing-qu}

<Route author="TonyRL" example="/playno1/st" path="/playno1/st/:catid?" paramsDesc={['分类，见下表，默认为全部文章']} radar="1" rssbud="1">
<Route author="TonyRL" example="/playno1/st" path="/playno1/st/:catid?" paramsDesc={['分类，见下表，默认为全部文章']} radar="1">

| 全部文章 | 情趣體驗報告 | 情趣新聞 | 情趣研究所 |
| -------- | ------------ | -------- | ---------- |
Expand Down Expand Up @@ -503,13 +503,13 @@ 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" configRequired="1"/>
<Route author="FeCCC" example="/zodgame/forum/13" path="/zodgame/forum/:fid?" paramsDesc={['forum id, can be found in URL']} radar="1" configRequired="1"/>

## Zuvio {#zuvio}

### 校園話題 {#zuvio-xiao-yuan-hua-ti}

<Route author="TonyRL" example="/zuvio/student5/34" path="/zuvio/student5/:board?" paramsDesc={['看板 ID，空为全站文章，可在看板 URL 或下方路由找到']} radar="1" rssbud="1"/>
<Route author="TonyRL" example="/zuvio/student5/34" path="/zuvio/student5/:board?" paramsDesc={['看板 ID，空为全站文章，可在看板 URL 或下方路由找到']} radar="1"/>

### 看板列表 {#zuvio-kan-ban-lie-biao}

Expand Down Expand Up @@ -592,7 +592,7 @@ When accessing Joeyray's Bar, `SCBOY_BBS_TOKEN` needs to be filled in `environme

### 子版块 {#di-yi-hui-suo-zi-ban-kuai}

<Route author="TonyRL" example="/sis001/forum/322" path="/sis001/forum/:id?" paramsDesc={['子版块 ID，可在子论坛 URL 找到，默认为 `Funny Jokes | 短篇笑话区`']} radar="1" rssbud="1"/>
<Route author="TonyRL" example="/sis001/forum/322" path="/sis001/forum/:id?" paramsDesc={['子版块 ID，可在子论坛 URL 找到，默认为 `Funny Jokes | 短篇笑话区`']} radar="1"/>

## 电鸭社区 {#dian-ya-she-qu}

Expand Down Expand Up @@ -1053,7 +1053,7 @@ When accessing Joeyray's Bar, `SCBOY_BBS_TOKEN` needs to be filled in `environme

### 社区 {#wei-feng-she-qu}

<Route author="TonyRL" example="/feng/forum/1" path="/feng/forum/:id/:type?" paramsDesc={['版块 ID，可在版块 URL 找到', '排序，见下表，默认为 `all`']} radar="1" rssbud="1">
<Route author="TonyRL" example="/feng/forum/1" path="/feng/forum/:id/:type?" paramsDesc={['版块 ID，可在版块 URL 找到', '排序，见下表，默认为 `all`']} radar="1">

| 最新回复 | 最新发布 | 热门 | 精华 |
| -------- | -------- | ---- | ------- |
Expand All @@ -1065,15 +1065,15 @@ When accessing Joeyray's Bar, `SCBOY_BBS_TOKEN` needs to be filled in `environme

### 博客 {#wen-xue-cheng-bo-ke}

<Route author="changlan" example="/wenxuecity/blog/43626" path="/wenxuecity/blog/:id" paramsDesc={['博客 ID, 可在 URL 中找到']} radar="1" rssbud="1"/>
<Route author="changlan" example="/wenxuecity/blog/43626" path="/wenxuecity/blog/:id" paramsDesc={['博客 ID, 可在 URL 中找到']} radar="1"/>

### 最热主题 {#wen-xue-cheng-zui-re-zhu-ti}

<Route author="changlan" example="/wenxuecity/hot/9" path="/wenxuecity/hot/:cid" paramsDesc={['版面 ID, 可在 URL 中找到']} radar="1"/>

### 最新主题 {#wen-xue-cheng-zui-xin-zhu-ti}

<Route author="changlan" example="/wenxuecity/bbs/tzlc" path="/wenxuecity/bbs/:cat/:elite?" paramsDesc={['版面名, 可在 URL 中找到', '是否精华区, 1 为精华区']} radar="1" rssbud="1"/>
<Route author="changlan" example="/wenxuecity/bbs/tzlc" path="/wenxuecity/bbs/:cat/:elite?" paramsDesc={['版面名, 可在 URL 中找到', '是否精华区, 1 为精华区']} radar="1"/>

### 焦点新闻 {#wen-xue-cheng-jiao-dian-xin-wen}

Expand All @@ -1083,7 +1083,7 @@ When accessing Joeyray's Bar, `SCBOY_BBS_TOKEN` needs to be filled in `environme

### 圈子 {#xiao-mi-she-qu-quan-zi}

<Route author="DIYgod" example="/mi/bbs/board/18066617" path="/mi/bbs/board/:boardId" paramsDesc={['圈子 id，可在圈子 URL 找到']} radar="1" rssbud="1"/>
<Route author="DIYgod" example="/mi/bbs/board/18066617" path="/mi/bbs/board/:boardId" paramsDesc={['圈子 id，可在圈子 URL 找到']} radar="1"/>

## 小木虫论坛 {#xiao-mu-chong-lun-tan}

Expand Down
24 changes: 12 additions & 12 deletions website/docs/routes/blog.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ username 为博主用户名，而非`xxx.hashnode.dev`中`xxx`所代表的 blog

### Category {#ian-spriggss-category}

<Route author="nczitzk" example="/ianspriggs/portraits" path="/ianspriggs/:category?" paramsDesc={['Category, see below, 3D PORTRAITS by default']} radar="1" rssbud="1">
<Route author="nczitzk" example="/ianspriggs/portraits" path="/ianspriggs/:category?" paramsDesc={['Category, see below, 3D PORTRAITS by default']} radar="1">

| 3D PORTRAITS | CHARACTERS |
| ------------ | ---------- |
Expand Down Expand Up @@ -250,7 +250,7 @@ Personalized recommendations require the cookie value after logging in, so only

### Essays {#paul-graham-essays}

<Route author="Maecenas nczitzk" example="/paulgraham/articles" path="/paulgraham/articles" radar="1" rssbud="1"/>
<Route author="Maecenas nczitzk" example="/paulgraham/articles" path="/paulgraham/articles" radar="1"/>

## Phrack Magazine {#phrack-magazine}

Expand Down Expand Up @@ -286,7 +286,7 @@ Limit the number of entries to be retrieved by adding `?limit=x` to the end of t

### Blog {#surfshark-blog}

<Route author="nczitzk" example="/surfshark/blog" path="/surfshark/blog/:category?" paramsDesc={['Category, can be found in URL ,see below, All by default']} radar="1" rssbud="1">
<Route author="nczitzk" example="/surfshark/blog" path="/surfshark/blog/:category?" paramsDesc={['Category, can be found in URL ,see below, All by default']} radar="1">

| Home | Cybersecurity | All things VPN | Internet censorship | Entertainment | News |
| ---- | ------------- | -------------- | ------------------- | ------------- | ---- |
Expand Down Expand Up @@ -316,7 +316,7 @@ Limit the number of entries to be retrieved by adding `?limit=x` to the end of t

### 最新文章 {#v1tx-zui-xin-wen-zhang}

<Route author="TonyRL" example="/v1tx" path="/v1tx" radar="1" rssbud="1" />
<Route author="TonyRL" example="/v1tx" path="/v1tx" radar="1" />

## Whoscall {#whoscall}

Expand Down Expand Up @@ -365,27 +365,27 @@ Limit the number of entries to be retrieved by adding `?limit=x` to the end of t

### 10 天推荐排行榜 {#bo-ke-yuan-10-tian-tui-jian-pai-hang-bang}

<Route author="hujingnb" example="/cnblogs/aggsite/topdiggs" path="/cnblogs/aggsite/topdiggs" radar="1" rssbud="1"/>
<Route author="hujingnb" example="/cnblogs/aggsite/topdiggs" path="/cnblogs/aggsite/topdiggs" radar="1"/>

### 48 小时阅读排行 {#bo-ke-yuan-48-xiao-shi-yue-du-pai-hang}

<Route author="hujingnb" example="/cnblogs/aggsite/topviews" path="/cnblogs/aggsite/topviews" radar="1" rssbud="1"/>
<Route author="hujingnb" example="/cnblogs/aggsite/topviews" path="/cnblogs/aggsite/topviews" radar="1"/>

### 编辑推荐 {#bo-ke-yuan-bian-ji-tui-jian}

<Route author="hujingnb" example="/cnblogs/aggsite/headline" path="/cnblogs/aggsite/headline" radar="1" rssbud="1"/>
<Route author="hujingnb" example="/cnblogs/aggsite/headline" path="/cnblogs/aggsite/headline" radar="1"/>

### 分类 {#bo-ke-yuan-fen-lei}

<Route author="hujingnb" example="/cnblogs/cate/go" path="/cnblogs/cate/:type" paramsDesc={['类型']} radar="1" rssbud="1">
<Route author="hujingnb" example="/cnblogs/cate/go" path="/cnblogs/cate/:type" paramsDesc={['类型']} radar="1">

在博客园主页的分类出可查看所有类型。例如，go 的分类地址为: `https://www.cnblogs.com/cate/go/`, 则: [`/cnblogs/cate/go`](https://rsshub.app/cnblogs/cate/go)

</Route>

### 精华区 {#bo-ke-yuan-jing-hua-qu}

<Route author="hujingnb" example="/cnblogs/pick" path="/cnblogs/pick" radar="1" rssbud="1"/>
<Route author="hujingnb" example="/cnblogs/pick" path="/cnblogs/pick" radar="1"/>

## 财新博客 {#cai-xin-bo-ke}

Expand Down Expand Up @@ -437,7 +437,7 @@ Limit the number of entries to be retrieved by adding `?limit=x` to the end of t

### 文章 {#jian-ning-xian-tan-wen-zhang}

<Route author="changlan" example="/blogs/jianning" path="/blogs/jianning" radar="1" rssbud="1"/>
<Route author="changlan" example="/blogs/jianning" path="/blogs/jianning" radar="1"/>

## 劍心．回憶 {#jian-xin-hui-yi}

Expand Down Expand Up @@ -515,7 +515,7 @@ Limit the number of entries to be retrieved by adding `?limit=x` to the end of t

### 专题展示 - 文章 {#shi-nian-zhi-yue-zhuan-ti-zhan-shi-wen-zhang}

<Route author="7Wate a180285" example="/foreverblog/feeds" path="/foreverblog/feeds" radar="1" rssbud="1" />
<Route author="7Wate a180285" example="/foreverblog/feeds" path="/foreverblog/feeds" radar="1" />

## 土猛的员外 {#tu-meng-de-yuan-wai}

Expand Down Expand Up @@ -585,4 +585,4 @@ Limit the number of entries to be retrieved by adding `?limit=x` to the end of t

### 上周热门 TOP 20 {#zhu-bai-shang-zhou-re-men-top-20}

<Route author="nczitzk" example="/zhubai/top20" path="/zhubai/top20" radar="1" rssbud="1"/>
<Route author="nczitzk" example="/zhubai/top20" path="/zhubai/top20" radar="1"/>
Loading

0 comments on commit a975237

Please sign in to comment.