Skip to content

Commit

Permalink
chore(deps): bump the docusaurus group in /website with 6 updates (#1…
Browse files Browse the repository at this point in the history
…3668)

* chore(deps): bump the docs group in /website with 6 updates

Bumps the docs group in /website with 6 updates:

| Package | From | To |
| --- | --- | --- |
| [@docusaurus/core](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus) | `2.4.3` | `3.0.0` |
| [@docusaurus/plugin-client-redirects](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-plugin-client-redirects) | `2.4.3` | `3.0.0` |
| [@docusaurus/plugin-pwa](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-plugin-pwa) | `2.4.3` | `3.0.0` |
| [@docusaurus/preset-classic](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-preset-classic) | `2.4.3` | `3.0.0` |
| [@docusaurus/module-type-aliases](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-module-type-aliases) | `2.4.3` | `3.0.0` |
| [@docusaurus/types](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-types) | `2.4.3` | `3.0.0` |


Updates `@docusaurus/core` from 2.4.3 to 3.0.0
- [Release notes](https://github.com/facebook/docusaurus/releases)
- [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/docusaurus/commits/v3.0.0/packages/docusaurus)

Updates `@docusaurus/plugin-client-redirects` from 2.4.3 to 3.0.0
- [Release notes](https://github.com/facebook/docusaurus/releases)
- [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/docusaurus/commits/v3.0.0/packages/docusaurus-plugin-client-redirects)

Updates `@docusaurus/plugin-pwa` from 2.4.3 to 3.0.0
- [Release notes](https://github.com/facebook/docusaurus/releases)
- [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/docusaurus/commits/v3.0.0/packages/docusaurus-plugin-pwa)

Updates `@docusaurus/preset-classic` from 2.4.3 to 3.0.0
- [Release notes](https://github.com/facebook/docusaurus/releases)
- [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/docusaurus/commits/v3.0.0/packages/docusaurus-preset-classic)

Updates `@docusaurus/module-type-aliases` from 2.4.3 to 3.0.0
- [Release notes](https://github.com/facebook/docusaurus/releases)
- [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/docusaurus/commits/v3.0.0/packages/docusaurus-module-type-aliases)

Updates `@docusaurus/types` from 2.4.3 to 3.0.0
- [Release notes](https://github.com/facebook/docusaurus/releases)
- [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/docusaurus/commits/v3.0.0/packages/docusaurus-types)

---
updated-dependencies:
- dependency-name: "@docusaurus/core"
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: docs
- dependency-name: "@docusaurus/plugin-client-redirects"
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: docs
- dependency-name: "@docusaurus/plugin-pwa"
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: docs
- dependency-name: "@docusaurus/preset-classic"
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: docs
- dependency-name: "@docusaurus/module-type-aliases"
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: docs
- dependency-name: "@docusaurus/types"
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: docs
...

Signed-off-by: dependabot[bot] <support@github.com>

* chore: fix dependencies

* docs: fix admonition

caution is deprecated in v3

caution(v2 yellow) => warning(v3 yellow)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  • Loading branch information
dependabot[bot] authored Nov 1, 2023
1 parent cc6241a commit 72f9a1f
Show file tree
Hide file tree
Showing 35 changed files with 3,013 additions and 1,062 deletions.
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ updates:
- dependency-name: string-width
versions: ['>=5.0.0']
groups:
docs:
docusaurus:
patterns:
- '@docusaurus/*'

Expand Down
2 changes: 1 addition & 1 deletion website/docs/api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API

:::caution
:::warning

The API is under active development and is subject to change. All suggestions are welcome!

Expand Down
8 changes: 4 additions & 4 deletions website/docs/install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ Automatic updates are included.

### Notice

:::caution Update
:::warning Update

Heroku [no longer](https://blog.heroku.com/next-chapter) offers free product plans.

Expand Down Expand Up @@ -505,7 +505,7 @@ If you would like to test routes or avoid IP limits, etc., you may build your ow

[![Try in PWD](https://raw.githubusercontent.com/play-with-docker/stacks/master/assets/images/button.png)](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/DIYgod/RSSHub/master/docker-compose.yml)

:::caution
:::warning

- [DockerHub](https://hub.docker.com) account required
- [Play with Docker](https://labs.play-with-docker.com/) instance will last for 4 hours at most. It should only be used for testing purpose
Expand Down Expand Up @@ -579,7 +579,7 @@ resolved by the SOCKS server, recommanded, prevents DNS poisoning or DNS leak),

### Reverse proxy

:::caution
:::warning

This proxy method cannot proxy requests that contain cookies.

Expand Down Expand Up @@ -859,7 +859,7 @@ See docs of the specified route and `lib/config.js` for detailed information.
- `EMAIL_CONFIG_{email}`: Mail setting, replace `{email}` with the email account, replace `@` and `.` in email account with `_`, e.g. `EMAIL_CONFIG_xxx_gmail_com`. The value is in the format of `password=password&host=server&port=port`, eg:
- Linux env: `EMAIL_CONFIG_xxx_qq_com="password=123456&host=imap.qq.com&port=993"`
- docker env: `EMAIL_CONFIG_xxx_qq_com=password=123456&host=imap.qq.com&port=993`, please do not include quotations `'`,`"`
- Note: socks5h proxy is not supported due to the limit of email lib `ImapFlow`
- Mastodon user timeline: apply API here `https://mastodon.example/settings/applications`(repalce `mastodon.example`), please check scope `read:search`
Expand Down
2 changes: 1 addition & 1 deletion website/docs/joinus/advanced/advanced-feed.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Each item in an RSS feed is represented by an object with a set of fields that d
| **`media.*`** | *(Optional)* The media associated with the item. See [Media RSS](https://www.rssboard.org/media-rss) for more details | `undefinded` | R |
| **`doi`** | *(Optional)* The Digital Object Identifier of the item, which should be a string in the format `10.xxxx/xxxxx.xxxx` | `undefinded` | R |

:::caution Formatting Considerations
:::warning Formatting Considerations

When specifying certain fields in an RSS feed, it's important to keep in mind some formatting considerations. Specifically, you should avoid including any linebreaks, consecutive whitespace, or leading/trailing whitespace in the following fields: **`title`**, **`subtitle`** (only for Atom), **`author`** (only for Atom), **`item.title`**, and **`item.author`**.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/joinus/advanced/use-cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The above code snippet from [Create Your Own RSSHub Route](/joinus/new-rss/start

The object returned from the previous statement will be reused, and an extra `description` property will be added to it. The returned cache for each `item.link` will be `{ title, link, pubDate, author, category, description }`. The next time the same path is requested, this processed cache will be used instead of making a request to the server and recomputing the data.

:::caution
:::warning

Any assignments to variables that are declared outside of the `tryGet()` function will not be processed under a cache-hit scenario. For example, the following code will not work as expected:

Expand Down
2 changes: 1 addition & 1 deletion website/docs/joinus/new-radar.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ The source field is *optional* and should specifies the URL path. Leave it blank

The source should be an array of strings. For example, if the source for `GitHub Repo Issues` is `/:user/:repo`, it means that when you visit `https://github.com/DIYgod/RSSHub`, which matches the `github.com/:user/:repo` pattern, the parameters for this URL will be: `{user: 'DIYgod', repo: 'RSSHub'}`. The browser extension uses these parameters to create an RSSHub subscription address based on the `target` field.

:::caution
:::warning

If the value you want to extract is in the URL search parameters or URL hash, use target as a function instead of the `source` field. Also, remember that the `source` field only matches the URL path and not any other parts of the URL.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/joinus/new-rss/add-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ npm run start
</TabItem>
</Tabs>

:::caution
:::warning

You cannot switch to other languages in development mode. This is a [technical limitation](https://docusaurus.io/docs/i18n/tutorial#start-your-site) from Docusaurus.

Expand Down Expand Up @@ -157,7 +157,7 @@ Supprts Markdown.

:::

:::caution
:::warning

Add a empty line around the starting and ending directive `:::`

Expand Down Expand Up @@ -195,7 +195,7 @@ Supprts Markdown.

:::

:::caution
:::warning

Add a empty line around the starting and ending directive `:::`

Expand Down
6 changes: 3 additions & 3 deletions website/docs/parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ E.g.

## Filtering

:::caution
:::warning

Please make sure you've [fully URL-encoded](https://gchq.github.io/CyberChef/#recipe=URL_Encode(true)) the parameters. Do not rely on the browser's automatic URL encoding. Some characters, such as `+`, `&`, will not be automatically encoded, resulting in the final parsing result not being correct.

:::

:::caution
:::warning

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)

Expand Down Expand Up @@ -120,7 +120,7 @@ E.g. [https://rsshub.app/theinitium/channel/latest/zh-hans?opencc=t2s](https://r

## Multimedia processing

:::caution
:::warning

This is an experimental API

Expand Down
4 changes: 2 additions & 2 deletions website/docs/routes/anime.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ For more tags, please go to [Search torrent](https://bangumi.moe/search/index)

<Route author="JimenezLi" example="/bangumi/tv/subject/328609/ep/true" path="/bangumi/tv/subject/:id/:type?/:showOriginalName?" paramsDesc={['条目 id, 在条目页面的地址栏查看', '条目类型,可选值为 `ep`, `comments`, `blogs`, `topics`,默认为 `ep`', '显示番剧标题原名,可选值 0/1/false/true,默认为 false']}>

:::caution
:::warning

此通用路由仅用于对路由参数的描述,具体信息请查看下方与条目相关的路由

Expand Down Expand Up @@ -348,7 +348,7 @@ If you subscribe to [Discounted works Latest Discounts - Newest to Oldest](https

<Route author="FeCCC" example="/iwara/subscriptions" path="/iwara/subscriptions" radar="1" rssbud="1" selfhost="1">

:::caution
:::warning

This route requires username and password, therefore it's only available when self-hosting, refer to the [Deploy Guide](/install/#route-specific-configurations) for route-specific configurations.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/routes/bbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@

## Dcard {#dcard}

:::caution
:::warning

僅能透過台灣 IP 抓取。

Expand All @@ -209,7 +209,7 @@

## Discourse {#discourse}

:::caution
:::warning

You need to set the environment variable `DISCOURSE_CONFIG_{id}` before using it. Please refer to Configuration section in the Deploy page of the documentation.

Expand All @@ -223,7 +223,7 @@ You need to set the environment variable `DISCOURSE_CONFIG_{id}` before using it

<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"/>

:::caution
:::warning

If you opt to enable `fulltext` feature, consider adding `limit` parameter to your query to avoid sending too many request.

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

### AV {#playno.1-wan-le-da-ren-av}

:::caution
:::warning

目前观测到该博客可能禁止日本 IP 访问。建议部署在日本区以外的服务器上。

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

The List ID is the last part of the URL after `-`, for example, the username in [https://medium.com/@imsingee/list/collection-7e67004f23f9](https://medium.com/@imsingee/list/collection-7e67004f23f9) is `imsingee`, and the ID is `7e67004f23f9`.

:::caution
:::warning

To access private lists, only self-hosting is supported.

Expand All @@ -188,7 +188,7 @@ To access private lists, only self-hosting is supported.

<Route author="ImSingee" example="/medium/for-you/imsingee" path="/medium/for-you/:user" paramsDesc={['Username']} selfhost="1">

:::caution
:::warning

Personalized recommendations require the cookie value after logging in, so only self-hosting is supported. See the configuration module on the deployment page for details.

Expand All @@ -200,7 +200,7 @@ Personalized recommendations require the cookie value after logging in, so only

<Route author="ImSingee" example="/medium/following/imsingee" path="/medium/following/:user" paramsDesc={['Username']} selfhost="1">

:::caution
:::warning

Personalized recommendations require the cookie value after logging in, so only self-hosting is supported. See the configuration module on the deployment page for details.

Expand All @@ -214,7 +214,7 @@ Personalized recommendations require the cookie value after logging in, so only

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`.

:::caution
:::warning

Personalized recommendations require the cookie value after logging in, so only self-hosting is supported. See the configuration module on the deployment page for details.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/routes/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Behance user's profile URL, like [https://www.behance.net/mishapetrick](https://
| :----: | :------: | :----------: | :--: | :--------------: |
| date | trending | popularity | alpha | style |

:::caution
:::warning

This route requires API key, therefore it's only available when self-hosting, refer to the [Deploy Guide](https://docs.rsshub.app/install/#configuration-route-specific-configurations) for route-specific configurations.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/routes/game.md
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ For instance, in `https://store.steampowered.com/search/?specials=1&term=atelier

## TapTap International {#taptap-international}

:::caution
:::warning

Due to the regional restrictions, an RSSHub deployment in China Mainland may not work on accessing the TapTap International Website.

Expand Down Expand Up @@ -523,7 +523,7 @@ Language Code

## TapTap 中国 {#taptap-zhong-guo}

:::caution
:::warning

由于区域限制,需要在有国内 IP 的机器上自建才能正常获取 RSS。\
而对于《TapTap 国际版》则需要部署在具有海外出口的 IP 上才可正常获取 RSS。
Expand Down
4 changes: 2 additions & 2 deletions website/docs/routes/government.md
Original file line number Diff line number Diff line change
Expand Up @@ -591,7 +591,7 @@ Language
| 国际司 | f784499ef24541f5b20de4c24cfc61e7 |
| 机关党委 | a49119c6f40045dd994f3910500cedfa |
| 离退办 | 6bf265ffd1c94fa4a3f1687b03fa908b |

</Route>

## 国家税务总局 {#guo-jia-shui-wu-zong-ju}
Expand Down Expand Up @@ -1769,7 +1769,7 @@ Language

<Route author="Jeason0228 TonyRL" example="/gov/customs/list/paimai" path="/gov/customs/list/:gchannel?" paramsDesc={['支持 `paimai``fagui` 2个频道,默认为 `paimai`']} anticrawler="1" puppeteer="1" radar="1" rssbud="1">

:::caution
:::warning

由于区域限制,建议在国内 IP 的机器上自建

Expand Down
4 changes: 2 additions & 2 deletions website/docs/routes/journal.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ Including 'cell', 'cancer-cell', 'cell-chemical-biology', 'cell-host-microbe', '

<Route author="HenryQW" path="/google/scholar/:query" example="/google/scholar/data+visualization" paramsDesc={['query statement which supports「Basic」and「Advanced」modes']} anticrawler="1">

:::caution
:::warning

Google Scholar has strict anti-crawling mechanism implemented, the demo below doesn't guarantee availability. Please deploy your own instance as it might increase the stability.

Expand Down Expand Up @@ -351,7 +351,7 @@ Subscribe to the cover images of the Nature journals, and get the latest publica

<Route author="y9c TonyRL" example="/nature/highlight" path="/nature/highlight/:journal?" paramsDesc={['short name for a journal, `nature` by default']} supportScihub="1" radar="1" rssbud="1">

:::caution
:::warning

Only some journals are supported.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/routes/live.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@

<Route author="Qixingchen" example="/bilibili/live/area/207/online" path="/bilibili/live/area/:areaID/:order" paramsDesc={['分区 ID 分区增删较多, 可通过 [分区列表](https://api.live.bilibili.com/room/v1/Area/getList) 查询', '排序方式, live_time 开播时间, online 人气']}>

:::caution
:::warning

由于接口未提供开播时间,如果直播间未更换标题与分区,将视为一次。如果直播间更换分区与标题,将视为另一项

Expand Down
4 changes: 2 additions & 2 deletions website/docs/routes/multimedia.md
Original file line number Diff line number Diff line change
Expand Up @@ -1833,7 +1833,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性

目前喜马拉雅的 API 只能一集一集的获取各节目上的 ShowNote,会极大的占用系统资源,所以默认为不获取节目的 ShowNote。下方有一个新的路径可选获取 ShowNote。

:::caution
:::warning

专辑类型即 url 中的分类拼音,使用通用分类 `album` 通常是可行的,专辑 id 是跟在**分类拼音**后的那个 id, 不要输成某集的 id 了

Expand All @@ -1855,7 +1855,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性

<Route author="prnake" example="/xiaoyuzhou" path="/xiaoyuzhou" selfhost="1">

:::caution
:::warning

小宇宙的 api 需要验证 `x-jike-device-id``x-jike-access-token``x-jike-refresh-token` 。必要时需要自行配置,具体见部署文档。

Expand Down
12 changes: 6 additions & 6 deletions website/docs/routes/new-media.md
Original file line number Diff line number Diff line change
Expand Up @@ -3132,7 +3132,7 @@ area 分区选项

通过提取文章全文,以提供比官方源更佳的阅读体验。

:::caution
:::warning

付费内容全文可能需要登陆获取,详情见部署页面的配置模块。

Expand Down Expand Up @@ -3164,7 +3164,7 @@ Type 栏目:

<Route author="AgFlore" example="/theinitium/follow/articles/zh-hans" path="/theinitium/follow/articles/:language?" paramsDesc={['语言,简体`zh-hans`,繁体`zh-hant`,缺省为简体']}>

:::caution
:::warning

需要自建,详情见部署页面的配置模块。

Expand Down Expand Up @@ -3613,7 +3613,7 @@ others = 热点新闻 + 滚动新闻

## 今日热榜 {#jin-ri-re-bang}

:::caution
:::warning

由于需要登录后的 Cookie 值才能获取原始链接,所以需要自建,需要在环境变量中配置 `TOPHUB_COOKIE`,详情见部署页面的配置模块。

Expand Down Expand Up @@ -5229,7 +5229,7 @@ column 为 third 时可选的 category:

## 网易新闻 {#wang-yi-xin-wen}

:::caution
:::warning

若视频因防盗链而无法播放,请参考 [通用参数 -> 多媒体处理](/parameter#多媒体处理) 配置 `multimedia_hotlink_template` **** `wrap_multimedia_in_iframe`

Expand Down Expand Up @@ -5333,7 +5333,7 @@ column 为 third 时可选的 category:

:::

:::caution
:::warning

该方法需要通过 efb 进行频道绑定,具体操作见 [https://github.com/DIYgod/RSSHub/issues/2172](https://github.com/DIYgod/RSSHub/issues/2172)

Expand Down Expand Up @@ -5383,7 +5383,7 @@ column 为 third 时可选的 category:

<Route author="Rongronggg9" example="/wechat/data258/gh_cbbad4c1d33c" path="/data258/:id?" paramsDesc={['公众号 id 或分类 id,可在公众号页或分类页 URL 中找到;若略去,则抓取首页']} anticrawler="1" radar="1" rssbud="1" selfhost="1">

:::caution
:::warning

由于使用了一些针对反爬的缓解措施,本路由响应较慢。默认只抓取前 5 条,可通过 `?limit=` 改变(不推荐,容易被反爬)。\
该网站使用 IP 甄别访客,且应用严格的每日阅读量限额(约 15 次),请自建并确保正确配置缓存;如使用内存缓存而非 Redis 缓存,请增大缓存容量。该限额足够订阅至少 3 个公众号 (假设公众号每日仅更新一次);首页 / 分类页更新相当频繁,不推荐订阅。
Expand Down
Loading

0 comments on commit 72f9a1f

Please sign in to comment.