From 94cd8b535633130777bf9788466b152387b56c71 Mon Sep 17 00:00:00 2001 From: wudifeixue Date: Fri, 29 Mar 2024 01:17:24 -0600 Subject: [PATCH 01/12] docs: add public instance --- .vitepress/theme/components/InstanceList.vue | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.vitepress/theme/components/InstanceList.vue b/.vitepress/theme/components/InstanceList.vue index f0518ab52..b54aad29b 100644 --- a/.vitepress/theme/components/InstanceList.vue +++ b/.vitepress/theme/components/InstanceList.vue @@ -107,6 +107,12 @@ const instances = [{ location: '🇩🇪', maintainer: 'Vincent Yang', maintainerUrl: 'https://missuo.me', + }, + { + url: 'https://rss.wudifeixue.com', + location: '🇨🇦', + maintainer: 'wudifeixue', + maintainerUrl: 'https://github.com/wudifeixue', } ] From c6fe7c393d4874e9dd5ac837b08522b9b6a727ca Mon Sep 17 00:00:00 2001 From: wudifeixue Date: Fri, 29 Mar 2024 01:57:53 -0600 Subject: [PATCH 02/12] docs: fix getting started --- src/guide/index.md | 6 +++--- src/zh/guide/index.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/guide/index.md b/src/guide/index.md index 865136e99..073d32f7f 100644 --- a/src/guide/index.md +++ b/src/guide/index.md @@ -8,13 +8,13 @@ To subscribe to a Twitter user's timeline, first look at the route document of [ The demo instance will generate an RSS feed at `https://rsshub.app/twitter/user/DIYgod`, use your own domain name when applicable. This feed should work with all RSS readers conforming to the RSS Standard. -You can replace the domain name `https://rsshub.app` with your [self-hosted instance](/install) or any [public instance](/instances). +You can replace the domain name `https://rsshub.app` with your [self-hosted instance](/deploy) or any [public instance](/guide/instances). -RSSHub supports additional parameters such as content filtering and full-text extraction, refer to [Parameters](/parameter) for details. +RSSHub supports additional parameters such as content filtering and full-text extraction, refer to [Parameters](/parameters) for details. ## Contribute a New Route -Our thriving community is the key to RSSHub's success, we invite everyone to join us and [contribute new routes](/joinus/quick-start) for all kinds of interesting sources. +Our thriving community is the key to RSSHub's success, we invite everyone to join us and [contribute new routes](/joinus/#quick-start) for all kinds of interesting sources. ## Use as a npm Package diff --git a/src/zh/guide/index.md b/src/zh/guide/index.md index 137da3b18..956db4afa 100644 --- a/src/zh/guide/index.md +++ b/src/zh/guide/index.md @@ -8,13 +8,13 @@ 然后我们可以把 `https://rsshub.app/twitter/user/DIYgod` 添加到任意 RSS 阅读器里来使用 -其中域名 `https://rsshub.app` 可以替换为你[自部署](/zh/install)或任意[公共实例](/zh/instances)的域名 +其中域名 `https://rsshub.app` 可以替换为你[自部署](/zh/deploy)或任意[公共实例](/zh/guide/instances)的域名 -另外 RSSHub 支持很多实用的参数，比如内容过滤、全文输出等，可以在 [通用参数](/zh/parameter) 文档了解具体使用方法 +另外 RSSHub 支持很多实用的参数，比如内容过滤、全文输出等，可以在 [通用参数](/zh/parameters) 文档了解具体使用方法 ## 编写订阅源 -RSSHub 的发展离不开社区的力量，欢迎编写你感兴趣的订阅源[参与我们](/zh/joinus/quick-start) +RSSHub 的发展离不开社区的力量，欢迎编写你感兴趣的订阅源[参与我们](/zh/joinus/#quick-start) ## 作为 npm 包使用 From 3e4ebe2c53bce291a79c2880c036187190e3692f Mon Sep 17 00:00:00 2001 From: wudifeixue Date: Fri, 29 Mar 2024 01:58:44 -0600 Subject: [PATCH 03/12] docs: fix public instances --- src/guide/instances.md | 2 +- src/zh/guide/instances.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/guide/instances.md b/src/guide/instances.md index f98fa6904..232127d29 100644 --- a/src/guide/instances.md +++ b/src/guide/instances.md @@ -2,7 +2,7 @@ Although the official instances are already stable enough, in order to achieve decentralization, we encourage users to host their own RSSHub instances or use other public RSSHub instances. -If you are willing to contribute your own instance for others to use, please edit [this file](https://github.com/DIYgod/RSSHub/tree/master/website/src/components/InstanceList.tsx) and submit a PR to add your instance to the list. +If you are willing to contribute your own instance for others to use, please edit [this file](https://github.com/RSSNext/rsshub-docs/edit/main/.vitepress/theme/components/InstanceList.vue) and submit a PR to add your instance to the list. ## Official diff --git a/src/zh/guide/instances.md b/src/zh/guide/instances.md index 8a6308072..e9fd2d952 100644 --- a/src/zh/guide/instances.md +++ b/src/zh/guide/instances.md @@ -2,7 +2,7 @@ 尽管官方实例已经足够稳定，但为了实现去中心化，我们鼓励用户自行托管 RSSHub 实例或使用其他公共 RSSHub 实例。 -如果你愿意贡献你自己的实例给他人使用，请编辑[此文件](https://github.com/DIYgod/RSSHub/tree/master/website/src/components/InstanceList.tsx) 并提交 PR 将你的实例添加到列表中。 +如果你愿意贡献你自己的实例给他人使用，请编辑[此文件](https://github.com/RSSNext/rsshub-docs/edit/main/.vitepress/theme/components/InstanceList.vue) 并提交 PR 将你的实例添加到列表中。 ## Official From 3eff671d6410c5825b0eafd826ddb8c68c5de635 Mon Sep 17 00:00:00 2001 From: wudifeixue Date: Fri, 29 Mar 2024 01:59:02 -0600 Subject: [PATCH 04/12] docs: fix faqs --- src/guide/faqs.md | 4 ++-- src/zh/guide/faqs.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/guide/faqs.md b/src/guide/faqs.md index 83308a6de..9055dd443 100644 --- a/src/guide/faqs.md +++ b/src/guide/faqs.md @@ -13,12 +13,12 @@ **A:** RSSHub fetches and respects the original image/video URLs from original sites, in which some are behind anti-hotlink filters. `referrerpolicy="no-referrer"` attribute is added to all images to solve the issues caused by cross-domain requests. Third party RSS service providers such as Feedly and Inoreader, strip this attribute off, resulting in cross-domain requests being blocked. Meanwhile, the attribute is not available for videos yet, resulting in most RSS readers unable to pass the anti-hotlink check. Here are some workarounds: 1. Migrate to RSS readers that do not send Referer，such as [Inoreader for Web](https://www.inoreader.com/) with a [user script disabling Referer](https://greasyfork.org/en/scripts/376884), [fix-image-error at inoreader](https://greasyfork.org/scripts/463461-fix-image-error-at-inoreader), [RSS to Telegram Bot](https://github.com/Rongronggg9/RSS-to-Telegram-Bot), etc. If your RSS reader can bypass the anti-hotlink check successfully and play embedded videos, it's an RSS reader that do not send Referer. Please consider adding it to the documentation to help more people. -2. Set up a reverse proxy, refer to [Parameters->Multimedia processing](/parameter#multimedia-processing) for more details. +2. Set up a reverse proxy, refer to [Parameters->Multimedia processing](/guide/parameters#multimedia-processing) for more details. 3. Navigate back to the original site. **Q: The website I want is not supported QAQ** -**A:** If you are a JavaScript developer, please follow [this guide](/joinus/quick-start) for submitting a pull request, otherwise, follow the issue template to [submit a new issue](https://github.com/DIYgod/RSSHub/issues/new?template=rss_request_en.md), and patiently wait for Santa Claus. For priority responses, consider [sponsoring us](/support). +**A:** If you are a JavaScript developer, please follow [this guide](/joinus/#quick-start) for submitting a pull request, otherwise, follow the issue template to [submit a new issue](https://github.com/DIYgod/RSSHub/issues/new?template=rss_request_en.md), and patiently wait for Santa Claus. For priority responses, consider [sponsoring us](/sponsor). **Q: Where do I get the changelog for RSSHub？** diff --git a/src/zh/guide/faqs.md b/src/zh/guide/faqs.md index 64c9880df..1c6612985 100644 --- a/src/zh/guide/faqs.md +++ b/src/zh/guide/faqs.md @@ -21,12 +21,12 @@ **A:** RSSHub 里的图片 / 视频地址都是源站地址，部分有防盗链，所以 RSSHub 给图片加了 `referrerpolicy="no-referrer"` 属性来防止跨域问题，但部分 RSS 服务会自作主张去掉这个属性，如 Feedly、Inoreader，在它们的网页端图片会触发跨域加载不出来。同时，视频目前没有类似的属性，因此大部分阅读器都无法通过防盗链检查。下面是一些解决方案： 1. 使用不发送 Referer 的阅读器，如 [Inoreader 网页版](https://www.inoreader.com/)配合[禁用 Referer 的 user script](https://greasyfork.org/scripts/376884)、[修复 inoreader 图片异常](https://greasyfork.org/scripts/463461-fix-image-error-at-inoreader)、[RSS to Telegram Bot](https://github.com/Rongronggg9/RSS-to-Telegram-Bot) 等。如果你的阅读器能够绕过防盗链成功播放内嵌视频，那么它就是不发送 Referer 的，请考虑添加到文档里帮助更多的人。 -2. 设置反代，参考 [通用参数 -> 多媒体处理](/zh/parameter#多媒体处理)。 +2. 设置反代，参考 [通用参数 -> 多媒体处理](/zh/guide/parameters#多媒体处理)。 3. 回到原网站查看相关资源。 **Q: 没有我想订阅的网站怎么办嘤嘤嘤 QAQ** -**A:** 如果你会写 JavaScript，请按照[规则](/zh/joinus/quick-start#提交新的-rsshub-规则)提交 pull request，否则按照要求[提交 issue](https://github.com/DIYgod/RSSHub/issues/new?template=rss_request_zh.md)，然后等待有缘人完成你的需求，也可以考虑[赞助项目](/zh/support)或附上一张你自己的女装照来获得更快的 issue 响应速度。 +**A:** 如果你会写 JavaScript，请按照[规则](/zh/joinus/#提交新的-rsshub-规则)提交 pull request，否则按照要求[提交 issue](https://github.com/DIYgod/RSSHub/issues/new?template=rss_request_zh.md)，然后等待有缘人完成你的需求，也可以考虑[赞助项目](/zh/sponsor)或附上一张你自己的女装照来获得更快的 issue 响应速度。 **Q: 我怎么才能知道 RSSHub 更新了哪些路由？** From b3dddbbd0219c63f588e605a702e51da4a7c602e Mon Sep 17 00:00:00 2001 From: wudifeixue Date: Fri, 29 Mar 2024 02:27:47 -0600 Subject: [PATCH 05/12] docs: fix parameters --- src/guide/parameters.md | 6 +++--- src/zh/guide/parameters.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/guide/parameters.md b/src/guide/parameters.md index f8828ccc1..0f5c793ee 100644 --- a/src/guide/parameters.md +++ b/src/guide/parameters.md @@ -25,7 +25,7 @@ Please make sure you've [fully URL-encoded](https://gchq.github.io/CyberChef/#re filter supports Regex, and due to the fact that some Regex are vulnerable to DoS (ReDoS), default engine `re2` blocks some of these functionalities available in node `Regexp`. These two engines also behaves a bit different in some corner cases. [Details](https://github.com/uhop/node-re2#limitations-things-re2-does-not-support) -If you need to use a different engine, please refer to [Deploy->Features->FILTER_REGEX_ENGINE](/deploy/#configuration-features). +If you need to use a different engine, please refer to [Deploy->Features->FILTER_REGEX_ENGINE](deploy/#configuration-features). ::: @@ -87,7 +87,7 @@ E.g. Bilibili article [https://rsshub.app/bilibili/user/article/334958638?mode=f ## Access Control -Set `key` or `code` to grant access to requests. See [Access Control Configuration](install/#configuration-access-control-configuration-access-key-code). +Set `key` or `code` to grant access to requests. See [Access Control Configuration](deploy/config#access-control-configurations). ## Telegram Instant View @@ -127,7 +127,7 @@ This is an experimental API - `multimedia_hotlink_template`: the same as `image_hotlink_template` but apply to audio and video. Note: the service must follow redirects, allow reverse-proxy for audio and video, and must drop the `Referer` header when reverse-proxying. [Here is an easy-to-deploy project that fits these requirements](https://github.com/Rongronggg9/rsstt-img-relay). The project accepts simple URL concatenation, e.g. `https://example.com/${href}`, in which `example.com` should be replaced with the domain name of the service you've deployed - `wrap_multimedia_in_iframe`: wrap audio and video in `