diff --git a/README.md b/README.md index 5026d69ce..1b3fd7ae0 100644 --- a/README.md +++ b/README.md @@ -25,11 +25,9 @@ RSSHub 是一个轻量、易于扩展的 RSS 生成器,可以给任何奇奇 ### Sponsors -- [Liuyang](https://github.com/lingllting) +| [Liuyang](https://github.com/lingllting) | Zuyang | [Sayori Studio](https://t.me/SayoriStudio) | Xiaojiong Wang | +| :--------------------------------------: | :----: | :----------------------------------------: | :------------: | -- Zuyang - -- [Sayori Studio](https://t.me/SayoriStudio) [![](https://opencollective.com/static/images/become_sponsor.svg)](https://docs.rsshub.app/support/) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 0dc5ed0da..08f97277c 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -32,7 +32,7 @@ module.exports = { }, nav: [ { - text: '使用', + text: '指南', link: '/', }, { @@ -63,7 +63,7 @@ module.exports = { }, nav: [ { - text: 'Usage', + text: 'Guide', link: '/en/', }, { diff --git a/docs/.vuepress/style.styl b/docs/.vuepress/style.styl index ca82cb29e..67c2a895d 100644 --- a/docs/.vuepress/style.styl +++ b/docs/.vuepress/style.styl @@ -26,3 +26,7 @@ a.sidebar-link { a { word-break: break-all; } + +#指南 { + display: none; +} diff --git a/docs/README.md b/docs/README.md index 362c2982b..12ab483df 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,6 +13,8 @@ RSSHub 是一个轻量、易于扩展的 RSS 生成器, 可以给任何奇奇怪 [Telegram 群](https://t.me/rsshub) +# 指南 + ## 鸣谢 ### Special Sponsors @@ -23,11 +25,9 @@ RSSHub 是一个轻量、易于扩展的 RSS 生成器, 可以给任何奇奇怪 ### Sponsors -- [Liuyang](https://github.com/lingllting) +| [Liuyang](https://github.com/lingllting) | Zuyang | [Sayori Studio](https://t.me/SayoriStudio) | Xiaojiong Wang | +| :--------------------------------------: | :----: | :----------------------------------------: | :------------: | -- Zuyang - -- [Sayori Studio](https://t.me/SayoriStudio) [![](https://opencollective.com/static/images/become_sponsor.svg)](https://docs.rsshub.app/support/) @@ -45,11 +45,11 @@ RSSHub 是一个轻量、易于扩展的 RSS 生成器, 可以给任何奇奇怪 ::: tip 提示 -所有通用参数可以组合使用, 效果叠加 +所有通用参数可以使用 `&` 连接组合使用, 效果叠加 ::: -#### 内容过滤 +### 内容过滤 可以使用以下 URL query 过滤内容, 支持正则 @@ -73,13 +73,13 @@ filterout 去掉不要的内容 举例: -#### 条数限制 +### 条数限制 可以使用 limit 参数限制最大条数, 主要用于排行榜类 RSS 举例: bilibili 排行榜前 10 -#### 输出格式 +### 输出格式 RSSHub 同时支持 RSS 2.0、Atom 和 [JSON Feed](https://jsonfeed.org/) 输出格式, 在路由末尾添加 `.rss` `.atom` 或 `.json` 即可请求对应输出格式, 缺省为 RSS 2.0 diff --git a/docs/en/README.md b/docs/en/README.md index 105bfca3c..c5c6b21ee 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -21,11 +21,9 @@ RSSHub is a lightweight and extensible RSS feed aggregator, it's able to generat ### Sponsors -- [Liuyang](https://github.com/lingllting) +| [Liuyang](https://github.com/lingllting) | Zuyang | [Sayori Studio](https://t.me/SayoriStudio) | Xiaojiong Wang | +| :--------------------------------------: | :----: | :----------------------------------------: | :------------: | -- Zuyang - -- [Sayori Studio](https://t.me/SayoriStudio) [![](https://opencollective.com/static/images/become_sponsor.svg)](https://docs.rsshub.app/support/) @@ -43,7 +41,7 @@ Free feel to test the [demo instance](https://rsshub.app), the cache expiry time ::: tip -All parameters can be used together to generate a complex feed +All parameters can be linked with `&` to used together to generate a complex feed :::