From b4f91e285c6f2d4406947a963aac65a51df3f019 Mon Sep 17 00:00:00 2001 From: DIYgod Date: Sat, 2 Dec 2023 03:04:09 +0800 Subject: [PATCH] docs: add radar description --- website/docs/usage.md | 20 +++++++++++++++++++ .../current/usage.md | 17 ++++++++++++++++ website/src/components/Route.tsx | 2 +- 3 files changed, 38 insertions(+), 1 deletion(-) diff --git a/website/docs/usage.md b/website/docs/usage.md index 5d9ad981e..af869512c 100644 --- a/website/docs/usage.md +++ b/website/docs/usage.md @@ -73,3 +73,23 @@ A short example for disabling caching can be written as: CACHE_TYPE: null, } ``` + +## Radar + +In addition to the two functions of generating RSS and obtaining data, RSSHub also provides a Radar function, which is used to map website addresses to RSSHub addresses. + +### Configuration file + +Radar has two types of configuration files, one is a full-featured [js file](https://github.com/DIYgod/RSSHub/blob/gh-pages/build/radar-rules.js), and the other is a simplified [json file]((https://github.com/DIYgod/RSSHub/blob/gh-pages/build/radar-rules.json)). + +### Usage + +You need to use supported browser extensions, mobile apps, RSS readers, or other tools to use the Radar feature. Please refer to the documentation of the corresponding tool for specific usage instructions. + +- Browser extension: [RSSHub Radar](https://github.com/DIYgod/RSSHub-Radar) + +- iOS app: [RSSBud](https://github.com/Cay-Zhang/RSSBud) + +- Android app: [RSSAid](https://github.com/LeetaoGoooo/RSSAid) + +- RSS Reader: Coming soon diff --git a/website/i18n/zh/docusaurus-plugin-content-docs/current/usage.md b/website/i18n/zh/docusaurus-plugin-content-docs/current/usage.md index 93fa5c418..440b2170b 100644 --- a/website/i18n/zh/docusaurus-plugin-content-docs/current/usage.md +++ b/website/i18n/zh/docusaurus-plugin-content-docs/current/usage.md @@ -71,3 +71,20 @@ RSSHub.request('/bilibili/bangumi/media/9192') CACHE_TYPE: null, } ``` + +## Radar + +除了生成 RSS 和获取数据两个功能之外,RSSHub 还提供了一个 Radar 功能,用于将网站地址映射到 RSSHub 地址 + +### 配置文件 + +Radar 有两种配置文件,一种是全功能的 [js 文件](https://github.com/DIYgod/RSSHub/blob/gh-pages/build/radar-rules.js),一种是简化的 [json 文件](https://github.com/DIYgod/RSSHub/blob/gh-pages/build/radar-rules.json) + +### 使用 + +你需要借助支持此功能的浏览器插件、手机应用、RSS 阅读器等工具来使用 Radar 功能,具体使用方法请参考对应工具的文档 + +- 浏览器插件: [RSSHub Radar](https://github.com/DIYgod/RSSHub-Radar) +- iOS 应用: [RSSBud](https://github.com/Cay-Zhang/RSSBud) +- Android 应用: [RSSAid](https://github.com/LeetaoGoooo/RSSAid) +- RSS 阅读器: Coming soon diff --git a/website/src/components/Route.tsx b/website/src/components/Route.tsx index d629fa580..e1ec6c508 100644 --- a/website/src/components/Route.tsx +++ b/website/src/components/Route.tsx @@ -58,7 +58,7 @@ export default function Route({ )} {radar && ( - + )}