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

doc: add a badge for self-host only routes

Browse Source
This commit is contained in:
Henry
2020-11-15 15:50:16 +00:00
parent b124b70a2e
commit d3ba01ac47
9 changed files with 41 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/.vuepress/components/Route.vue
View File

@@ -1,7 +1,7 @@
<template> <template>
<div class="routeBlock" :id="path"> <div class="routeBlock" :id="path">
<p class="badge"> <p class="badge">
<Badge text="支持 BT" type="tip" vertical="middle" v-if="supportBT"/> <Badge text="支持播客" type="tip" vertical="middle" v-if="supportPodcast"/> <Badge text="支持 Scihub" type="tip" vertical="middle" v-if="supportScihub"/> <a target="_blank" href="/faq.html" v-if="anticrawler"><Badge text="反爬严格" vertical="middle" type="warn"/></a> <a target="_blank" href="https://github.com/DIYgod/RSSHub-Radar" v-if="radar"><Badge text="支持浏览器扩展" vertical="middle" type="tip"/></a> <a target="_blank" href="https://github.com/Cay-Zhang/RSSBud" v-if="rssbud"><Badge text="支持 RSSBud" vertical="middle" type="tip"/></a> <Badge text="支持 BT" type="tip" vertical="middle" v-if="supportBT"/> <Badge text="支持播客" type="tip" vertical="middle" v-if="supportPodcast"/> <Badge text="支持 Scihub" type="tip" vertical="middle" v-if="supportScihub"/> <a target="_blank" href="/faq.html" v-if="anticrawler"><Badge text="反爬严格" vertical="middle" type="warn"/></a> <a target="_blank" href="https://github.com/DIYgod/RSSHub-Radar" v-if="radar"><Badge text="支持浏览器扩展" vertical="middle" type="tip"/></a> <a target="_blank" href="https://github.com/Cay-Zhang/RSSBud" v-if="rssbud"><Badge text="支持 RSSBud" vertical="middle" type="tip"/></a><a target="_blank" href="https://docs.rsshub.app/install/" v-if="selfhost"><Badge text="仅支持自建" vertical="middle" type="warn"/></a>
</p> </p>
<p class="author"> <p class="author">
作者: <a v-for="uid in author.split(' ')" :href="`https://github.com/${uid}`" target="_blank"> @{{ uid }} </a> 作者: <a v-for="uid in author.split(' ')" :href="`https://github.com/${uid}`" target="_blank"> @{{ uid }} </a>
@@ -75,14 +75,3 @@ export default {
} }
} }
</script> </script>
<style>
li.params p {
display: inline;
}
.routeBlock {
margin: 1rem 0 2rem;
}
#app .page .badge.tip {
background-color: #FFB74D;
}
</style>

17
docs/.vuepress/components/RouteEn.vue
View File

@@ -1,7 +1,7 @@
<template> <template>
<div class="routeBlock" :id="path"> <div class="routeBlock" :id="path">
<p class="badge"> <p class="badge">
<Badge text="support BT" type="tip" vertical="middle" v-if="supportBT"/> <Badge text="support podcast" type="tip" vertical="middle" v-if="supportPodcast"/> <a target="_blank" href="/en/faq.html" v-if="anticrawler"><Badge text="strict anti-crawler policy" vertical="middle" type="warn"/></a> <a target="_blank" href="https://github.com/DIYgod/RSSHub-Radar" v-if="radar"><Badge text="support browser extension" vertical="middle" type="tip"/></a> <a target="_blank" href="https://github.com/Cay-Zhang/RSSBud" v-if="rssbud"><Badge text="support rssbud" vertical="middle" type="tip"/></a> <Badge text="support BT" type="tip" vertical="middle" v-if="supportBT"/> <Badge text="support podcast" type="tip" vertical="middle" v-if="supportPodcast"/> <a target="_blank" href="/en/faq.html" v-if="anticrawler"><Badge text="strict anti-crawler policy" vertical="middle" type="warn"/></a> <a target="_blank" href="https://github.com/DIYgod/RSSHub-Radar" v-if="radar"><Badge text="support browser extension" vertical="middle" type="tip"/></a> <a target="_blank" href="https://github.com/Cay-Zhang/RSSBud" v-if="rssbud"><Badge text="support rssbud" vertical="middle" type="tip"/></a><a target="_blank" href="https://docs.rsshub.app/en/install/" v-if="selfhost"><Badge text="self-host only" vertical="middle" type="warn"/></a>
</p> </p>
<p class="author"> <p class="author">
Author: <a v-for="uid in author.split(' ')" :href="`https://github.com/${uid}`" target="_blank"> @{{ uid }} </a> Author: <a v-for="uid in author.split(' ')" :href="`https://github.com/${uid}`" target="_blank"> @{{ uid }} </a>
@@ -60,6 +60,10 @@ export default {
type: String, type: String,
default: null default: null
}, },
selfhost: {
type: String,
default: null
},
}, },
methods: { methods: {
renderMarkdown(item) { renderMarkdown(item) {
@@ -71,14 +75,3 @@ export default {
} }
} }
</script> </script>
<style>
li.params p {
display: inline;
}
.routeBlock {
margin: 1rem 0 2rem;
}
#app .page .badge.tip {
background-color: #FFB74D;
}
</style>

17
docs/.vuepress/styles/index.styl
View File

@@ -42,3 +42,20 @@ h3 {
.sidebar-sub-headers a.sidebar-link { .sidebar-sub-headers a.sidebar-link {
color: #F5712C; color: #F5712C;
} }
// for Route and RouteEn components
li.params p {
display: inline;
}
.routeBlock {
margin: 1rem 0 2rem;
}
#app .page .badge.tip {
background-color: #FFB74D;
}
#app .page .badge.warn {
background-color: #ff774d;
}

2
docs/en/other.md
View File

@@ -75,7 +75,7 @@ Official Website: [https://www.ssm.gov.mo/apps1/PreventWuhanInfection/en.aspx](h
> Only support IMAP protocol, email password and other settings refer to [Email setting](/en/install) > Only support IMAP protocol, email password and other settings refer to [Email setting](/en/install)
<RouteEn author="kt286" example="/mail/imap/rss@rsshub.app" path="/mail/imap/:email" :paramsDesc="['Email account']" /> <RouteEn author="kt286" example="/mail/imap/rss@rsshub.app" path="/mail/imap/:email" :paramsDesc="['Email account']" selfhost="1"/>
## Emi Nitta official website ## Emi Nitta official website

8
docs/en/social-media.md
View File

@@ -46,7 +46,7 @@ If you don't want to setup credentials, use Picuki.
### User Profile ### User Profile
<RouteEn author="oppilate" example="/instagram/user/stefaniejoosten" path="/instagram/:category/:key" :paramsDesc="['Feed category. Only user category is supported for now.','Key for such category. E.g. username/ID for user feed']"/> <RouteEn author="oppilate" example="/instagram/user/stefaniejoosten" path="/instagram/:category/:key" :paramsDesc="['Feed category. Only user category is supported for now.','Key for such category. E.g. username/ID for user feed']" selfhost="1"/>
## Lofter ## Lofter
@@ -133,7 +133,7 @@ These feed do not include boosts (a.k.a. reblogs). RSSHub provides a feed for us
### Following timeline ### Following timeline
<RouteEn author="ClarkeCheng" example="/pixiv/user/illustfollows" path="/pixiv/user/illustfollows" radar="1" rssbud="1"/> <RouteEn author="ClarkeCheng" example="/pixiv/user/illustfollows" path="/pixiv/user/illustfollows" radar="1" rssbud="1" selfhost="1"/>
::: warning ::: warning
Only for self-hosted Only for self-hosted
@@ -214,11 +214,11 @@ generates
## User following timeline ## User following timeline
<RouteEn author="DIYgod" example="/twitter/followings/DIYgod" path="/twitter/followings/:id/:routeParams?" :paramsDesc="['user id', 'extra parameters, see the table above']" radar="1" rssbud="1"> <RouteEn author="DIYgod" example="/twitter/followings/DIYgod" path="/twitter/followings/:id/:routeParams?" :paramsDesc="['user id', 'extra parameters, see the table above']" radar="1" rssbud="1" selfhost="1">
::: warning ::: warning
This route requires Twitter token's corresponding id, therefore it's only availble when self-hosting, refer to the [Deploy Guide](/en/install/#route-specific-configurations) for route-specific configurations. This route requires Twitter token's corresponding id, therefore it's only available when self-hosting, refer to the [Deploy Guide](/en/install/#route-specific-configurations) for route-specific configurations.
::: :::

4
docs/multimedia.md
View File

@@ -704,7 +704,7 @@ pageClass: routes
### 专辑 ### 专辑
<Route author="lengthmin jjeejj prnake" example="/ximalaya/album/299146" path="/ximalaya/album/:id/:all?" :paramsDesc="['专辑 id, 可在对应专辑页面的 URL 中找到','是否需要获取全部节目，默认不获取，填入该字段则视为获取']" supportPodcast="1" radar="1" rssbud="1"> <Route author="lengthmin jjeejj prnake" example="/ximalaya/album/299146" path="/ximalaya/album/:id/:all?" :paramsDesc="['专辑 id, 可在对应专辑页面的 URL 中找到','是否需要获取全部节目，默认不获取，填入该字段则视为获取']" supportPodcast="1" radar="1" rssbud="1" selfhost="1">
::: warning 注意 ::: warning 注意
专辑 id 是跟在**分类拼音**后的那个 id, 不要输成某集的 id 了 专辑 id 是跟在**分类拼音**后的那个 id, 不要输成某集的 id 了
@@ -724,7 +724,7 @@ pageClass: routes
### 发现 ### 发现
<Route author="prnake" example="/xiaoyuzhou" path="/xiaoyuzhou"> <Route author="prnake" example="/xiaoyuzhou" path="/xiaoyuzhou" selfhost="1">
::: warning 注意 ::: warning 注意

8
docs/other.md
View File

@@ -137,7 +137,7 @@ pageClass: routes
### 订阅列表 ### 订阅列表
<Route author="emdoe" example="/miniflux/subscription/categories=科技,影音" path="/miniflux/subscription/:parameters?" :paramsDesc="['分类名或分类 ID 或/且 订阅源名称或订阅源 ID']"> <Route author="emdoe" example="/miniflux/subscription/categories=科技,影音" path="/miniflux/subscription/:parameters?" :paramsDesc="['分类名或分类 ID 或/且 订阅源名称或订阅源 ID']" selfhost="1">
1. 如无指定参数，默认输出全部订阅源 1. 如无指定参数，默认输出全部订阅源
2. 分类 ID 或订阅源 ID 请于`分类`（快捷键 `g` `c`）或`源`（快捷键 `g` `f`）页面获取，每个分类（或订阅源）的网址即显示其 ID 信息。 2. 分类 ID 或订阅源 ID 请于`分类`（快捷键 `g` `c`）或`源`（快捷键 `g` `f`）页面获取，每个分类（或订阅源）的网址即显示其 ID 信息。
@@ -149,7 +149,7 @@ pageClass: routes
### 获取订阅源内容 ### 获取订阅源内容
<Route author="emdoe" example="/miniflux/feeds=1&2&3/mark=read&limit=7&status=unread" path="/miniflux/:feeds/:parameters?" :paramsDesc="['订阅源 ID 或获取全部', '过滤及设置参数，多个请用 `&` 连接']"> <Route author="emdoe" example="/miniflux/feeds=1&2&3/mark=read&limit=7&status=unread" path="/miniflux/:feeds/:parameters?" :paramsDesc="['订阅源 ID 或获取全部', '过滤及设置参数，多个请用 `&` 连接']" selfhost="1">
1. 支持获取全部内容：即可通过 `/miniflux/all` 或 `/miniflux/default` 等关键字获取全部订阅源下的内容。 1. 支持获取全部内容：即可通过 `/miniflux/all` 或 `/miniflux/default` 等关键字获取全部订阅源下的内容。
2. 支持通过订阅源的 ID 获取指定订阅源的订阅内容，订阅源 ID 请于`源`（快捷键 `g` `f`）所在的页面获取，每个分类（或订阅源）的网址即显示其 ID 信息。而格式上有如下选择： 2. 支持通过订阅源的 ID 获取指定订阅源的订阅内容，订阅源 ID 请于`源`（快捷键 `g` `f`）所在的页面获取，每个分类（或订阅源）的网址即显示其 ID 信息。而格式上有如下选择：
@@ -812,7 +812,7 @@ type 为 all 时，category 参数不支持 cost 和 free
> 仅支持 IMAP 协议，邮件密码等设置见 [邮件设置](/install/#其他应用配置) > 仅支持 IMAP 协议，邮件密码等设置见 [邮件设置](/install/#其他应用配置)
<Route author="kt286" example="/mail/imap/rss@rsshub.app" path="/mail/imap/:email" :paramsDesc="['邮箱账号']" /> <Route author="kt286" example="/mail/imap/rss@rsshub.app" path="/mail/imap/:email" :paramsDesc="['邮箱账号']" selfhost="1"/>
## 源仓库 ## 源仓库
@@ -922,7 +922,7 @@ type 为 all 时，category 参数不支持 cost 和 free
### 4399 论坛 ### 4399 论坛
<Route author="DIYgod" example="/forum4399/mtag-83932" path="/forum4399/:mtag" :paramsDesc="['mtag,必选-论坛网址最后的mtag字段']"/> <Route author="DIYgod" example="/forum4399/mtag-83932" path="/forum4399/:mtag" :paramsDesc="['mtag,必选-论坛网址最后的mtag字段']" selfhost="1"/>
::: warning 注意 ::: warning 注意
需要用户 cookie 值，详情见部署页面的配置模块。 需要用户 cookie 值，详情见部署页面的配置模块。

12
docs/social-media.md
View File

@@ -208,7 +208,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性
### 用户关注动态 ### 用户关注动态
<Route author="TigerWolfDen" example="/bilibili/followings/dynamic/109937383" path="/bilibili/followings/dynamic/:uid/:disableEmbed?" :paramsDesc="['用户 id', '默认为开启内嵌视频, 任意值为关闭']"> <Route author="TigerWolfDen" example="/bilibili/followings/dynamic/109937383" path="/bilibili/followings/dynamic/:uid/:disableEmbed?" :paramsDesc="['用户 id', '默认为开启内嵌视频, 任意值为关闭']" selfhost="1">
::: warning 注意 ::: warning 注意
用户动态需要 b 站登录后的 Cookie 值，所以只能自建，详情见部署页面的配置模块。 用户动态需要 b 站登录后的 Cookie 值，所以只能自建，详情见部署页面的配置模块。
@@ -218,7 +218,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性
### 用户关注视频动态 ### 用户关注视频动态
<Route author="LogicJake" example="/bilibili/followings/video/2267573" path="/bilibili/followings/video/:uid/:disableEmbed?" :paramsDesc="['用户 id', '默认为开启内嵌视频, 任意值为关闭']"> <Route author="LogicJake" example="/bilibili/followings/video/2267573" path="/bilibili/followings/video/:uid/:disableEmbed?" :paramsDesc="['用户 id', '默认为开启内嵌视频, 任意值为关闭']" selfhost="1">
::: warning 注意 ::: warning 注意
用户动态需要 b 站登录后的 Cookie 值，所以只能自建，详情见部署页面的配置模块。 用户动态需要 b 站登录后的 Cookie 值，所以只能自建，详情见部署页面的配置模块。
@@ -228,7 +228,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性
### 用户关注专栏 ### 用户关注专栏
<Route author="woshiluo" example="/bilibili/followings/article/99800931" path="/bilibili/followings/article/:uid" :paramsdesc="['用户 id']"> <Route author="woshiluo" example="/bilibili/followings/article/99800931" path="/bilibili/followings/article/:uid" :paramsdesc="['用户 id']" selfhost="1">
::: warning 注意 ::: warning 注意
用户动态需要 b 站登录后的 Cookie 值，所以只能自建，详情见部署页面的配置模块。 用户动态需要 b 站登录后的 Cookie 值，所以只能自建，详情见部署页面的配置模块。
@@ -437,7 +437,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性
### 关注的新作品 ### 关注的新作品
<Route author="ClarkeCheng" example="/pixiv/user/illustfollows" path="/pixiv/user/illustfollows" radar="1" rssbud="1"/> <Route author="ClarkeCheng" example="/pixiv/user/illustfollows" path="/pixiv/user/illustfollows" radar="1" rssbud="1" selfhost="1"/>
::: warning 注意 ::: warning 注意
因为每个人关注的画师不同，所以只能自建。请不要将画师设为 “悄悄关注”，这样子画师的作品就不会出现在订阅里了。 因为每个人关注的画师不同，所以只能自建。请不要将画师设为 “悄悄关注”，这样子画师的作品就不会出现在订阅里了。
@@ -532,7 +532,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性
### 用户关注时间线 ### 用户关注时间线
<Route author="DIYgod" example="/twitter/followings/DIYgod" path="/twitter/followings/:id/:routeParams?" :paramsDesc="['用户名', '额外参数；请参阅上面的说明和表格']" radar="1" rssbud="1"> <Route author="DIYgod" example="/twitter/followings/DIYgod" path="/twitter/followings/:id/:routeParams?" :paramsDesc="['用户名', '额外参数；请参阅上面的说明和表格']" radar="1" rssbud="1" selfhost="1">
::: warning 注意 ::: warning 注意
@@ -986,7 +986,7 @@ rule
::: :::
<Route author="zytomorrow DIYgod" example="/weibo/timeline/3306934123" path="/weibo/timeline/:uid/:feature?" :paramsDesc="['用户的uid', ' 过滤类型ID，0：全部、1：原创、2：图片、3：视频、4：音乐，默认为0。']" anticrawler="1"> <Route author="zytomorrow DIYgod" example="/weibo/timeline/3306934123" path="/weibo/timeline/:uid/:feature?" :paramsDesc="['用户的uid', ' 过滤类型ID，0：全部、1：原创、2：图片、3：视频、4：音乐，默认为0。']" anticrawler="1" selfhost="1">
::: warning 注意 ::: warning 注意

2
docs/university.md
View File

@@ -226,7 +226,7 @@ pageClass: routes
### BTBYR 趣味盒 ### BTBYR 趣味盒
<Route author="prnake" example="/bupt/funbox" path="/bupt/funbox" /> <Route author="prnake" example="/bupt/funbox" path="/bupt/funbox" selfhost="1"/>
::: warning 注意 ::: warning 注意
由于需要登陆 BTBYR 后的 Cookie 值，所以只能自建，并且部署和订阅端均需支持 IPV6 网络或使用镜像站点。 由于需要登陆 BTBYR 后的 Cookie 值，所以只能自建，并且部署和订阅端均需支持 IPV6 网络或使用镜像站点。