From 1df0597fffd138d45b96d63c88091f0b88685dbf Mon Sep 17 00:00:00 2001 From: DIYgod Date: Thu, 15 Oct 2020 11:01:17 +0800 Subject: [PATCH] Revert "style: auto format" This reverts commit 10d16bd30a191852b9c6e8f032e3e2d5aa457ac4. --- docs/README.md | 12 +-- docs/anime.md | 6 +- docs/api.md | 2 +- docs/bbs.md | 8 +- docs/blog.md | 6 +- docs/design.md | 6 +- docs/finance.md | 8 +- docs/forecast.md | 10 +-- docs/game.md | 8 +- docs/government.md | 56 ++++++------ docs/install/README.md | 182 +++++++++++++++++++------------------- docs/joinus/README.md | 57 ++++++------ docs/journal.md | 24 ++--- docs/live.md | 6 +- docs/multimedia.md | 26 +++--- docs/new-media.md | 28 +++--- docs/other.md | 6 +- docs/parameter.md | 34 +++---- docs/picture.md | 30 +++---- docs/program-update.md | 6 +- docs/programming.md | 24 ++--- docs/reading.md | 6 +- docs/shopping.md | 10 +-- docs/social-media.md | 28 +++--- docs/study.md | 26 +++--- docs/support/README.md | 18 ++-- docs/traditional-media.md | 42 ++++----- docs/travel.md | 10 +-- docs/university.md | 10 +-- 29 files changed, 348 insertions(+), 347 deletions(-) diff --git a/docs/README.md b/docs/README.md index 5d092c0eb..a92991cda 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ -*** - -## sidebarDepth: 0 +--- +sidebarDepth: 0 +--- # 介绍 @@ -19,7 +19,7 @@ RSSHub 是一个开源、简单易用、易于扩展的 RSS 生成器,可以 可以配合浏览器扩展 [RSSHub Radar](https://github.com/DIYgod/RSSHub-Radar) 和 iOS 辅助 App [RSSBud](https://github.com/Cay-Zhang/RSSBud) 食用 -[Telegram 群](https://t.me/rsshub) | [Telegram 频道](https://t.me/awesomeRSSHub) +[Telegram 群](https://t.me/rsshub) \| [Telegram 频道](https://t.me/awesomeRSSHub) ## 鸣谢 @@ -45,5 +45,5 @@ Logo designer [sheldonrrr](https://dribbble.com/sheldonrrr) ## 相关项目 -* [RSSHub Radar](https://github.com/DIYgod/RSSHub-Radar) | 一个可以帮助你快速发现和订阅当前网站 RSS 和 RSSHub 的浏览器扩展 -* [RSSBud](https://github.com/Cay-Zhang/RSSBud) ([TestFlight 公测](https://testflight.apple.com/join/rjCVzzHP)) | iOS 平台的 RSSHub Radar,专为移动生态优化 +- [RSSHub Radar](https://github.com/DIYgod/RSSHub-Radar) | 一个可以帮助你快速发现和订阅当前网站 RSS 和 RSSHub 的浏览器扩展 +- [RSSBud](https://github.com/Cay-Zhang/RSSBud) ([TestFlight 公测](https://testflight.apple.com/join/rjCVzzHP)) | iOS 平台的 RSSHub Radar,专为移动生态优化 diff --git a/docs/anime.md b/docs/anime.md index f1f25bb94..b6d6f4ec4 100644 --- a/docs/anime.md +++ b/docs/anime.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 二次元 diff --git a/docs/api.md b/docs/api.md index fd9dc4c8f..212237619 100644 --- a/docs/api.md +++ b/docs/api.md @@ -18,7 +18,7 @@ RSSHub 提供下列 API 接口: 参数: -* name, 路由一级名称,对应 中的文件夹名称。可选,**缺省则返回所有可用路由**. +- name, 路由一级名称,对应 中的文件夹名称。可选,**缺省则返回所有可用路由**. 成功请求将会返回 HTTP 状态码 `200 OK` 与 JSON 结果,格式如下: diff --git a/docs/bbs.md b/docs/bbs.md index 1b0af217e..87380afaa 100644 --- a/docs/bbs.md +++ b/docs/bbs.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 论坛 @@ -486,7 +486,7 @@ 2. 打开控制台 3. 切换到 Network 面板 4. 点击 搜索 按钮 -5. 点击 results?ps=15\&pg=1 POST 请求 +5. 点击 results?ps=15&pg=1 POST 请求 6. 找到 Request Payload 请求参数,例如 filters: {planyr: "13", planmajor: "1", outname_w: "ACADIAU"} ,则三个 id 分别为: 13,1,ACADIAU ::: diff --git a/docs/blog.md b/docs/blog.md index 673721664..831f8b83d 100644 --- a/docs/blog.md +++ b/docs/blog.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 博客 diff --git a/docs/design.md b/docs/design.md index 15870ebda..ff4cc2204 100644 --- a/docs/design.md +++ b/docs/design.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 设计 diff --git a/docs/finance.md b/docs/finance.md index 7c6553bb3..49653029e 100644 --- a/docs/finance.md +++ b/docs/finance.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 金融 @@ -60,7 +60,7 @@ ### 搜索关键字 -\ - -其中 name 参数,请略过本地服务的区域码,例如 `https://outage.report/us/verizon-wireless` 填入 `verizon-wireless` 即可。 + +其中 name 参数, 请略过本地服务的区域码, 例如 `https://outage.report/us/verizon-wireless` 填入 `verizon-wireless` 即可。 diff --git a/docs/game.md b/docs/game.md index cff57d635..df52423af 100644 --- a/docs/game.md +++ b/docs/game.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 游戏 @@ -152,7 +152,7 @@ 适用于 URL 如 的游戏。 -比如 PlayStation Store 香港简体中文区的 [《赛博朋克 2077》](https://store.playstation.com/zh-hans-hk/product/HP4497-CUSA16570\_00-ASIAFULLGAME0000) 的 lang 为 `zh-hans-hk`, gridName 为 `HP4497-CUSA16570_00-ASIAFULLGAME0000` +比如 PlayStation Store 香港简体中文区的 [《赛博朋克 2077》](https://store.playstation.com/zh-hans-hk/product/HP4497-CUSA16570_00-ASIAFULLGAME0000) 的 lang 为 `zh-hans-hk`, gridName 为 `HP4497-CUSA16570_00-ASIAFULLGAME0000` diff --git a/docs/government.md b/docs/government.md index 14518ee5b..ec3971b11 100644 --- a/docs/government.md +++ b/docs/government.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 政务消息 @@ -341,21 +341,21 @@ #### 德国 `DE` -* 大使馆: `/embassy/de` +- 大使馆: `/embassy/de` -* 领事馆城市列表: +- 领事馆城市列表: | 城市 | 路由 | | ------ | -------------------- | | 慕尼黑 | `/embassy/de/munich` | -*** +* * * #### 法国 `FR` -* 大使馆: `/embassy/fr` +- 大使馆: `/embassy/fr` -* 领事馆城市列表: +- 领事馆城市列表: | 城市 | 路由 | | ---------- | ------------------------ | @@ -363,13 +363,13 @@ | 斯特拉斯堡 | `/embassy/fr/strasbourg` | | 里昂 | `/embassy/fr/lyon` | -*** +* * * #### 日本 `JP` -* 大使馆: `/embassy/jp` +- 大使馆: `/embassy/jp` -* 领事馆城市列表: +- 领事馆城市列表: | 城市 | 路由 | | ------ | ---------------------- | @@ -380,13 +380,13 @@ | 札幌 | `/embassy/jp/sapporo` | | 新潟 | `/embassy/jp/niigata` | -*** +* * * #### 韩国 `KR` -* 大使馆: `/embassy/kr` +- 大使馆: `/embassy/kr` -* 领事馆城市列表: +- 领事馆城市列表: | 城市 | 路由 | | ---- | --------------------- | @@ -394,25 +394,25 @@ | 济州 | `/embassy/kr/jeju` | | 光州 | `/embassy/kr/gwangju` | -*** +* * * #### 马来西亚 `MY` -* 大使馆: `/embassy/my` +- 大使馆: `/embassy/my` -*** +* * * #### 新加坡 `SG` -* 大使馆: `/embassy/sg` +- 大使馆: `/embassy/sg` -*** +* * * #### 美国 `US` -* 大使馆: `/embassy/us` +- 大使馆: `/embassy/us` -* 领事馆城市列表: +- 领事馆城市列表: | 城市 | 路由 | | ------ | -------------------------- | @@ -420,13 +420,13 @@ | 芝加哥 | `/embassy/us/chicago` | | 旧金山 | `/embassy/us/sanfrancisco` | -*** +* * * #### 英国 `UK` -* 大使馆: `/embassy/uk` +- 大使馆: `/embassy/uk` -* 领事馆城市列表: +- 领事馆城市列表: | 城市 | 路由 | | ---------- | ------------------------ | @@ -466,10 +466,10 @@ 更多例子: -* `农业农村部动态`的网页链接是`http://www.moa.gov.cn/xw/zwdt/`, 对应的`suburl`是`xw/zwdt` -* `财务公开`的网页链接是`http://www.moa.gov.cn/gk/cwgk_1/`, 对应的`suburl`是`gk/cwgk_1` -* 像[政策法规](http://www.moa.gov.cn/gk/zcfg/)这种页面 (`http://www.moa.gov.cn/gk/zcfg/`), 它**不是**一个合法的分类目录,它是`法律`, `行政法规`, `部门规章`等一堆栏目的集合,这时候请点开对应栏目的`更多 >>`进入栏目的目录,再根据上面的规则提取`suburl` -* 特别地,`图片新闻`对应的`suburl`为`xw/tpxw/`, `最新公开`对应的`suburl`为`govpublic` +- `农业农村部动态`的网页链接是`http://www.moa.gov.cn/xw/zwdt/`, 对应的`suburl`是`xw/zwdt` +- `财务公开`的网页链接是`http://www.moa.gov.cn/gk/cwgk_1/`, 对应的`suburl`是`gk/cwgk_1` +- 像[政策法规](http://www.moa.gov.cn/gk/zcfg/)这种页面 (`http://www.moa.gov.cn/gk/zcfg/`), 它**不是**一个合法的分类目录,它是`法律`, `行政法规`, `部门规章`等一堆栏目的集合,这时候请点开对应栏目的`更多 >>`进入栏目的目录,再根据上面的规则提取`suburl` +- 特别地,`图片新闻`对应的`suburl`为`xw/tpxw/`, `最新公开`对应的`suburl`为`govpublic` diff --git a/docs/install/README.md b/docs/install/README.md index 0e7f7b795..ebcf42a91 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -1,6 +1,6 @@ -*** - -## sidebar: auto +--- +sidebar: auto +--- # 部署 @@ -287,7 +287,7 @@ env_variables: gcloud app deploy ``` -进行项目部署,如果您需要变更 app.yaml 文件名称或者变更部署的项目 ID 或者指定版本号等,请参考 [Deploying a service](https://cloud.google.com/appengine/docs/flexible/nodejs/testing-and-deploying-your-app#deploying_a_service\_2)。 +进行项目部署,如果您需要变更 app.yaml 文件名称或者变更部署的项目 ID 或者指定版本号等,请参考 [Deploying a service](https://cloud.google.com/appengine/docs/flexible/nodejs/testing-and-deploying-your-app#deploying_a_service_2)。 部署完成后可访问您的 Google App Engine URL 查看部署情况。 @@ -299,10 +299,10 @@ gcloud app deploy ::: warning 注意 -* 需要 [DockerHub](https://hub.docker.com) 账号 -* [Play with Docker](https://labs.play-with-docker.com/) 一次仅能使用 4 小时,不能作为持久化解决方案,应当用于测试 / 验证路由规则 -* 如果部署完成后不能看到自动识别的端口,请手动点击顶部按钮`open port`并输入`1200` -* 有的时候 PWD 会抽风,如果遇到点击`Start`后空白页面,或者拉起失败,请重试 +- 需要 [DockerHub](https://hub.docker.com) 账号 +- [Play with Docker](https://labs.play-with-docker.com/) 一次仅能使用 4 小时,不能作为持久化解决方案,应当用于测试 / 验证路由规则 +- 如果部署完成后不能看到自动识别的端口,请手动点击顶部按钮`open port`并输入`1200` +- 有的时候 PWD 会抽风,如果遇到点击`Start`后空白页面,或者拉起失败,请重试 ::: @@ -336,17 +336,17 @@ RSSHub 支持 `memory` 和 `redis` 两种缓存方式 > 代理 URI 的格式为: > -> * `{protocol}://{host}:{port}` -> * `{protocol}://{username}:{password}@{host}:{port}` (带身份凭证) +> - `{protocol}://{host}:{port}` +> - `{protocol}://{username}:{password}@{host}:{port}` (带身份凭证) > > 一些示例: > -> * `socks4://127.0.0.1:1080` -> * `socks5://user:pass@127.0.0.1:1080` (用户名为 `user`, 密码为 `pass`) -> * `socks://127.0.0.1:1080` (protocol 为 socks 时表示 `socks5`) -> * `http://127.0.0.1:8080` -> * `http://user:pass@127.0.0.1:8080` -> * `https://127.0.0.1:8443` +> - `socks4://127.0.0.1:1080` +> - `socks5://user:pass@127.0.0.1:1080` (用户名为 `user`, 密码为 `pass`) +> - `socks://127.0.0.1:1080` (protocol 为 socks 时表示 `socks5`) +> - `http://127.0.0.1:8080` +> - `http://user:pass@127.0.0.1:8080` +> - `https://127.0.0.1:8443` #### 代理选项 @@ -378,25 +378,25 @@ RSSHub 支持使用访问密钥 / 码,白名单和黑名单三种方式进行 #### 黑白名单 -* `WHITELIST`: 白名单,设置白名单后黑名单无效 +- `WHITELIST`: 白名单,设置白名单后黑名单无效 -* `BLACKLIST`: 黑名单 +- `BLACKLIST`: 黑名单 黑白名单支持 IP 和路由,设置多项时用英文逗号 `,` 隔开,例如 `WHITELIST=1.1.1.1,2.2.2.2,/qdaily/column/59` #### 访问密钥 / 码 -* `ACCESS_KEY`: 访问密钥,用于直接访问所有路由或者生成访问码 +- `ACCESS_KEY`: 访问密钥,用于直接访问所有路由或者生成访问码 访问码为 访问密钥 + 路由 共同生成的 md5,例如: | 访问密钥 | 路由 | 生成过程 | 访问码 | | ----------- | ----------------- | ---------------------------------------- | -------------------------------- | -| ILoveRSSHub | /qdaily/column/59 | md5 ('/qdaily/column/59' + 'ILoveRSSHub') | 0f820530128805ffc10351f22b5fd121 | +| ILoveRSSHub | /qdaily/column/59 | md5('/qdaily/column/59' + 'ILoveRSSHub') | 0f820530128805ffc10351f22b5fd121 | -* 此时可以通过 `code` 访问路由,例如: +- 此时可以通过 `code` 访问路由,例如: -* 或使用访问密钥 `key` 直接访问所有路由,例如: +- 或使用访问密钥 `key` 直接访问所有路由,例如: 访问密钥 / 码与黑白名单的访问控制关系如下: @@ -424,7 +424,7 @@ RSSHub 支持使用访问密钥 / 码,白名单和黑名单三种方式进行 `NODE_NAME`: 节点名,用于负载均衡,识别当前节点 -`PUPPETEER_WS_ENDPOINT`: 用于 puppeteer.connect 的浏览器 websocket 链接,见 [browserWSEndpoint](https://zhaoqize.github.io/puppeteer-api-zh_CN/#?product=Puppeteer\&version=v1.14.0\&show=api-browserwsendpoint) +`PUPPETEER_WS_ENDPOINT`: 用于 puppeteer.connect 的浏览器 websocket 链接,见 [browserWSEndpoint](https://zhaoqize.github.io/puppeteer-api-zh_CN/#?product=Puppeteer&version=v1.14.0&show=api-browserwsendpoint) `SENTRY`: [Sentry](https://sentry.io) dsn,用于错误追踪 @@ -440,127 +440,127 @@ RSSHub 支持使用访问密钥 / 码,白名单和黑名单三种方式进行 ::: -* pixiv 全部路由:[注册地址](https://accounts.pixiv.net/signup) +- pixiv 全部路由:[注册地址](https://accounts.pixiv.net/signup) - * `PIXIV_USERNAME`: Pixiv 用户名 + - `PIXIV_USERNAME`: Pixiv 用户名 - * `PIXIV_PASSWORD`: Pixiv 密码 + - `PIXIV_PASSWORD`: Pixiv 密码 -* pixiv fanbox 用于获取付费内容 +- pixiv fanbox 用于获取付费内容 - * `FANBOX_SESSION_ID`: 对应 cookies 中的`FANBOXSESSID`。 + - `FANBOX_SESSION_ID`: 对应 cookies 中的`FANBOXSESSID`。 -* disqus 全部路由:[申请地址](https://disqus.com/api/applications/) +- disqus 全部路由:[申请地址](https://disqus.com/api/applications/) - * `DISQUS_API_KEY`: Disqus API + - `DISQUS_API_KEY`: Disqus API -* twitter 全部路由:[申请地址](https://apps.twitter.com) +- twitter 全部路由:[申请地址](https://apps.twitter.com) - * `TWITTER_CONSUMER_KEY`: Twitter Consumer Key,支持多个 key,用英文逗号 `,` 隔开 + - `TWITTER_CONSUMER_KEY`: Twitter Consumer Key,支持多个 key,用英文逗号 `,` 隔开 - * `TWITTER_CONSUMER_SECRET`: Twitter Consumer Secret,支持多个 key,用英文逗号 `,` 隔开,顺序与 key 对应 + - `TWITTER_CONSUMER_SECRET`: Twitter Consumer Secret,支持多个 key,用英文逗号 `,` 隔开,顺序与 key 对应 - * `TWITTER_TOKEN_{id}`: 对应 id 的 Twitter token,`{id}` 替换为 id,值为 `consumer_key consumer_secret access_token access_token_secret` 用逗号隔开,即:`{consumer_key},{consumer_secret},{access_token},{access_token_secret}` + - `TWITTER_TOKEN_{id}`: 对应 id 的 Twitter token,`{id}` 替换为 id,值为 `consumer_key consumer_secret access_token access_token_secret` 用逗号隔开,即:`{consumer_key},{consumer_secret},{access_token},{access_token_secret}` -* youtube 全部路由:[申请地址](https://console.developers.google.com/) +- youtube 全部路由:[申请地址](https://console.developers.google.com/) - * `YOUTUBE_KEY`: YouTube API Key,支持多个 key,用英文逗号 `,` 隔开 + - `YOUTUBE_KEY`: YouTube API Key,支持多个 key,用英文逗号 `,` 隔开 -* telegram - 贴纸包路由:[Telegram 机器人](https://telegram.org/blog/bot-revolution) +- telegram - 贴纸包路由:[Telegram 机器人](https://telegram.org/blog/bot-revolution) - * `TELEGRAM_TOKEN`: Telegram 机器人 token + - `TELEGRAM_TOKEN`: Telegram 机器人 token -* github 全部路由:[申请地址](https://github.com/settings/tokens) +- github 全部路由:[申请地址](https://github.com/settings/tokens) - * `GITHUB_ACCESS_TOKEN`: GitHub Access Token + - `GITHUB_ACCESS_TOKEN`: GitHub Access Token -* bilibili 用户关注视频动态路由 +- bilibili 用户关注视频动态路由 - * `BILIBILI_COOKIE_{uid}`: 对应 uid 的 b 站用户登录后的 Cookie 值,`{uid}` 替换为 uid,如 `BILIBILI_COOKIE_2267573`,获取方式:1. 打开 2. 打开控制台 3. 切换到 Network 面板 4. 刷新 5. 点击 dynamic_new 请求 6. 找到 Cookie + - `BILIBILI_COOKIE_{uid}`: 对应 uid 的 b 站用户登录后的 Cookie 值,`{uid}` 替换为 uid,如 `BILIBILI_COOKIE_2267573`,获取方式:1. 打开 2. 打开控制台 3. 切换到 Network 面板 4. 刷新 5. 点击 dynamic_new 请求 6. 找到 Cookie -* 语雀 全部路由:[注册地址](https://www.yuque.com/register) +- 语雀 全部路由:[注册地址](https://www.yuque.com/register) - * `YUQUE_TOKEN`: 语雀 Token,[获取地址](https://www.yuque.com/settings/tokens)。语雀接口做了访问频率限制,为保证正常访问建议配置 Token,详见 [语雀开发者文档](https://www.yuque.com/yuque/developer/api#5b3a1535)。 + - `YUQUE_TOKEN`: 语雀 Token,[获取地址](https://www.yuque.com/settings/tokens)。语雀接口做了访问频率限制,为保证正常访问建议配置 Token,详见 [语雀开发者文档](https://www.yuque.com/yuque/developer/api#5b3a1535)。 -* 邮箱 邮件列表路由: +- 邮箱 邮件列表路由: - * `EMAIL_CONFIG_{email}`: 邮箱设置,替换 `{email}` 为 邮箱账号,邮件账户的 `@` 替换为 `.`,例如 `EMAIL_CONFIG_xxx.qq.com`。内容格式为 `password=密码&host=服务器&port=端口`,例如: - * Linux 环境变量:`EMAIL_CONFIG_xxx.qq.com="password=123456&host=imap.qq.com&port=993"` - * docker 环境变量:`EMAIL_CONFIG_xxx.qq.com=password=123456&host=imap.qq.com&port=993`,请勿添加引号 `'`,`"`。 + - `EMAIL_CONFIG_{email}`: 邮箱设置,替换 `{email}` 为 邮箱账号,邮件账户的 `@` 替换为 `.`,例如 `EMAIL_CONFIG_xxx.qq.com`。内容格式为 `password=密码&host=服务器&port=端口`,例如: + - Linux 环境变量:`EMAIL_CONFIG_xxx.qq.com="password=123456&host=imap.qq.com&port=993"` + - docker 环境变量:`EMAIL_CONFIG_xxx.qq.com=password=123456&host=imap.qq.com&port=993`,请勿添加引号 `'`,`"`。 -* 吹牛部落 栏目更新 +- 吹牛部落 栏目更新 - * `CHUINIU_MEMBER`: 吹牛部落登录后的 x-member,获取方式:1. 登陆后点开文章正文 2. 打开控制台 3. 刷新 4. 找到 开头的请求 5. 找到请求头中的 x-member + - `CHUINIU_MEMBER`: 吹牛部落登录后的 x-member,获取方式:1. 登陆后点开文章正文 2. 打开控制台 3. 刷新 4. 找到 开头的请求 5. 找到请求头中的 x-member -* 微博 个人时间线路由:[申请地址](https://open.weibo.com/connect) +- 微博 个人时间线路由:[申请地址](https://open.weibo.com/connect) - * `WEIBO_APP_KEY`: 微博 App Key - * `WEIBO_APP_SECRET`: 微博 App Secret - * `WEIBO_REDIRECT_URL`: 微博登录授权回调地址,默认为 `RSSHub 地址/weibo/timeline/0`,自定义回调地址请确保最后可以转跳到 `RSSHub 地址/weibo/timeline/0?code=xxx` + - `WEIBO_APP_KEY`: 微博 App Key + - `WEIBO_APP_SECRET`: 微博 App Secret + - `WEIBO_REDIRECT_URL`: 微博登录授权回调地址,默认为 `RSSHub 地址/weibo/timeline/0`,自定义回调地址请确保最后可以转跳到 `RSSHub 地址/weibo/timeline/0?code=xxx` -* Mastodon 用户时间线路由:访问 `https://mastodon.example/settings/applications` 申请(替换掉 `mastodon.example`)。需要 `read:search` 权限 +- Mastodon 用户时间线路由:访问 `https://mastodon.example/settings/applications` 申请(替换掉 `mastodon.example`)。需要 `read:search` 权限 - * `MASTODON_API_HOST`: API 请求的实例 - * `MASTODON_API_ACCESS_TOKEN`: 用户 access token, 申请应用后,在应用配置页可以看到申请者的 access token - * `MASTODON_API_ACCT_DOMAIN`: 该实例本地用户 acct 标识的域名 + - `MASTODON_API_HOST`: API 请求的实例 + - `MASTODON_API_ACCESS_TOKEN`: 用户 access token, 申请应用后,在应用配置页可以看到申请者的 access token + - `MASTODON_API_ACCT_DOMAIN`: 该实例本地用户 acct 标识的域名 -* 饭否 全部路由:[申请地址](https://github.com/FanfouAPI/FanFouAPIDoc/wiki/Oauth) +- 饭否 全部路由:[申请地址](https://github.com/FanfouAPI/FanFouAPIDoc/wiki/Oauth) - * `FANFOU_CONSUMER_KEY`: 饭否 Consumer Key - * `FANFOU_CONSUMER_SECRET`: 饭否 Consumer Secret - * `FANFOU_USERNAME`: 饭否登录用户名、邮箱、手机号 - * `FANFOU_PASSWORD`: 饭否密码 + - `FANFOU_CONSUMER_KEY`: 饭否 Consumer Key + - `FANFOU_CONSUMER_SECRET`: 饭否 Consumer Secret + - `FANFOU_USERNAME`: 饭否登录用户名、邮箱、手机号 + - `FANFOU_PASSWORD`: 饭否密码 -* Last.fm 全部路由:[申请地址](https://www.last.fm/api/) +- Last.fm 全部路由:[申请地址](https://www.last.fm/api/) - * `LASTFM_API_KEY`: Last.fm API Key + - `LASTFM_API_KEY`: Last.fm API Key -* 北大未名 BBS 全站十大 +- 北大未名 BBS 全站十大 - * `PKUBBS_COOKIE`: BBS 注册用户登录后的 Cookie 值,获取方式:1. 登录后打开论坛首页 2. 打开控制台 3. 刷新 4. 找到 请求 5. 找到请求头中的 Cookie + - `PKUBBS_COOKIE`: BBS 注册用户登录后的 Cookie 值,获取方式:1. 登录后打开论坛首页 2. 打开控制台 3. 刷新 4. 找到 请求 5. 找到请求头中的 Cookie -* nhentai torrent: [注册地址](https://nhentai.net/register/) +- nhentai torrent: [注册地址](https://nhentai.net/register/) - * `NHENTAI_USERNAME`: nhentai 用户名或邮箱 - * `NHENTAI_PASSWORD`: nhentai 密码 + - `NHENTAI_USERNAME`: nhentai 用户名或邮箱 + - `NHENTAI_PASSWORD`: nhentai 密码 -* discuz cookies 设定 +- discuz cookies 设定 - * `DISCUZ_COOKIE_{cid}`: 某 Discuz 驱动的论坛,用户注册后的 Cookie 值,cid 可自由设定,取值范围 \[00, 99], 使用 discuz 通用路由时,通过指定 cid 来调用该 cookie + - `DISCUZ_COOKIE_{cid}`: 某 Discuz 驱动的论坛,用户注册后的 Cookie 值,cid 可自由设定,取值范围[00, 99], 使用 discuz 通用路由时,通过指定 cid 来调用该 cookie -* Sci-hub 设置,用于科学期刊路由。 +- Sci-hub 设置,用于科学期刊路由。 - * `SCIHUB_HOST`: 可访问的 sci-hub 镜像地址,默认为 `https://sci-hub.tw`。 + - `SCIHUB_HOST`: 可访问的 sci-hub 镜像地址,默认为 `https://sci-hub.tw`。 -* 端传媒设置,用于获取付费内容全文: +- 端传媒设置,用于获取付费内容全文: - * `INITIUM_BEARER_TOKEN`: 端传媒 Web 版认证 token。获取方式:登陆后打开端传媒站内任意页面,打开浏览器开发者工具中 “网络”(Network) 选项卡,筛选 URL 找到任一个地址为`api.initium.com`开头的请求,点击检查其 “消息头”,在 “请求头” 中找到`Authorization`字段,将其值复制填入配置即可。你的配置应该形如`INITIUM_BEARER_TOKEN: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6JiE1NTYzNDgxNDVAcXEuY29tIiwidXNlcl9pZCI6MTM0NDIwLCJlbWFpbCI6IjE1NTYzNDgxNDVAcXEuY29tIiwiZXhwIjoxNTk0MTk5NjQ3fQ.Tqui-ORNR7d4Bh240nKy_Ldi6crfq0A78Yj2iwy2_U8'`。 + - `INITIUM_BEARER_TOKEN`: 端传媒 Web 版认证 token。获取方式:登陆后打开端传媒站内任意页面,打开浏览器开发者工具中 “网络”(Network) 选项卡,筛选 URL 找到任一个地址为`api.initium.com`开头的请求,点击检查其 “消息头”,在 “请求头” 中找到`Authorization`字段,将其值复制填入配置即可。你的配置应该形如`INITIUM_BEARER_TOKEN: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6JiE1NTYzNDgxNDVAcXEuY29tIiwidXNlcl9pZCI6MTM0NDIwLCJlbWFpbCI6IjE1NTYzNDgxNDVAcXEuY29tIiwiZXhwIjoxNTk0MTk5NjQ3fQ.Tqui-ORNR7d4Bh240nKy_Ldi6crfq0A78Yj2iwy2_U8'`。 如果你在进行上述操作时遇到困难,亦可选择在环境设置中填写明文的用户名和密码: - * `INITIUM_USERNAME`: 端传媒用户名 (邮箱) - * `INITIUM_PASSWORD`: 端传媒密码 + - `INITIUM_USERNAME`: 端传媒用户名 (邮箱) + - `INITIUM_PASSWORD`: 端传媒密码 -* BTBYR +- BTBYR - * `BTBYR_HOST`: 支持 ipv4 访问的 BTBYR 镜像,默认为原站 `https://bt.byr.cn/`。 - * `BTBYR_COOKIE`: 注册用户登录后的 Cookie 值,获取方式:1. 登录后打开网站首页 2. 打开控制台 3. 刷新 4. 找到 请求 5. 找到请求头中的 Cookie + - `BTBYR_HOST`: 支持 ipv4 访问的 BTBYR 镜像,默认为原站 `https://bt.byr.cn/`。 + - `BTBYR_COOKIE`: 注册用户登录后的 Cookie 值,获取方式:1. 登录后打开网站首页 2. 打开控制台 3. 刷新 4. 找到 请求 5. 找到请求头中的 Cookie -* 小宇宙:需要 App 登陆后抓包获取相应数据。 +- 小宇宙:需要 App 登陆后抓包获取相应数据。 - * `XIAOYUZHOU_ID`: 即数据包中的 `x-jike-device-id`。 - * `XIAOYUZHOU_TOKEN`: 即数据包中的 `x-jike-refresh-token`。 + - `XIAOYUZHOU_ID`: 即数据包中的 `x-jike-device-id`。 + - `XIAOYUZHOU_TOKEN`: 即数据包中的 `x-jike-refresh-token`。 -* 新榜 +- 新榜 - * `NEWRANK_COOKIE`: 登陆后的 COOKIE 值,其中 token 是必要的,其他可删除 + - `NEWRANK_COOKIE`: 登陆后的 COOKIE 值,其中 token 是必要的,其他可删除 -* NGA BBS 用于获取帖子内文 +- NGA BBS 用于获取帖子内文 - * `NGA_PASSPORT_UID`: 对应 cookie 中的 `ngaPassportUid`. + - `NGA_PASSPORT_UID`: 对应 cookie 中的 `ngaPassportUid`. - * `NGA_PASSPORT_CID`: 对应 cookie 中的 `ngaPassportCid`. + - `NGA_PASSPORT_CID`: 对应 cookie 中的 `ngaPassportCid`. -* 喜马拉雅 +- 喜马拉雅 - * `XIMALAYA_TOKEN`: 对应 cookie 中的 `1&_token`,获取方式:1. 登陆喜马拉雅网页版 2. 查找名称为`1&_token`的`cookie`,其内容即为`XIMALAYA_TOKEN`的值(即在`cookie` 中查找 `1&_token=***;`,并设置 `XIMALAYA_TOKEN = ***`) + - `XIMALAYA_TOKEN`: 对应 cookie 中的 `1&_token`,获取方式:1. 登陆喜马拉雅网页版 2. 查找名称为`1&_token`的`cookie`,其内容即为`XIMALAYA_TOKEN`的值(即在`cookie` 中查找 `1&_token=***;`,并设置 `XIMALAYA_TOKEN = ***`) diff --git a/docs/joinus/README.md b/docs/joinus/README.md index d17f1cfe4..e493c1f77 100644 --- a/docs/joinus/README.md +++ b/docs/joinus/README.md @@ -1,6 +1,6 @@ -*** - -## sidebar: auto +--- +sidebar: auto +--- # 参与我们 @@ -29,15 +29,15 @@ #### 获取源数据 -* 获取源数据的主要手段为使用 [got](https://github.com/sindresorhus/got) 发起 HTTP 请求(请求接口或请求网页)获取数据 +- 获取源数据的主要手段为使用 [got](https://github.com/sindresorhus/got) 发起 HTTP 请求(请求接口或请求网页)获取数据 -* 个别情况需要使用 [puppeteer](https://github.com/GoogleChrome/puppeteer) 模拟浏览器渲染目标页面并获取数据 +- 个别情况需要使用 [puppeteer](https://github.com/GoogleChrome/puppeteer) 模拟浏览器渲染目标页面并获取数据 -* 返回的数据一般为 JSON 或 HTML 格式 +- 返回的数据一般为 JSON 或 HTML 格式 -* 对于 HTML 格式的数据,使用 [cheerio](https://github.com/cheeriojs/cheerio) 进行处理 +- 对于 HTML 格式的数据,使用 [cheerio](https://github.com/cheeriojs/cheerio) 进行处理 -* 以下三种获取数据方法按 **「推荐优先级」** 排列: +- 以下三种获取数据方法按 **「推荐优先级」** 排列: 1. **使用 got 从接口获取数据** @@ -59,7 +59,7 @@ // 这个对象中包含了数组名为 data,所以 response.data.data 则为需要的数据 ``` - 返回的数据样例之一(response.data.data \[0]): + 返回的数据样例之一(response.data.data[0]): ```json { @@ -217,7 +217,7 @@ 4. **使用通用配置型路由** - 很大一部分网站是可以通过一个配置范式来生成 RSS 的。\ + 很大一部分网站是可以通过一个配置范式来生成 RSS 的。 通用配置即通过 cheerio(**CSS 选择器、jQuery 函数**)读取 json 数据来简便的生成 RSS。 首先我们需要几个数据: @@ -269,7 +269,7 @@ 至此我们完成了一个最简单的路由 -*** +* * * #### 使用缓存 @@ -294,7 +294,7 @@ const description = await ctx.cache.tryGet(link, async () => { tryGet 的实现可以看[这里](https://github.com/DIYgod/RSSHub/blob/master/lib/middleware/cache.js#L128),第一个参数为缓存的 key,第二个参数为缓存数据获取方法,第三个参数为缓存时间,正常情况不应该传入,缓存时间默认为 [CACHE_CONTENT_EXPIRE](/install/#缓存配置),且每次访问缓存会重新计算过期时间 -*** +* * * #### 生成 RSS 源 @@ -383,22 +383,22 @@ ctx.state.data = { }; ``` -*** +* * * ### 添加脚本文档 1. 更新 [文档 (/docs/) ](https://github.com/DIYgod/RSSHub/blob/master/docs/) 目录内对应的文档,可以执行 `npm run docs:dev` 查看文档效果 - * 文档采用 vue 组件形式,格式如下: - * `author`: 路由作者,多位作者使用单个空格分隔 - * `example`: 路由举例 - * `path`: 路由路径 - * `:paramsDesc`: 路由参数说明,数组,支持 markdown + - 文档采用 vue 组件形式,格式如下: + - `author`: 路由作者,多位作者使用单个空格分隔 + - `example`: 路由举例 + - `path`: 路由路径 + - `:paramsDesc`: 路由参数说明,数组,支持 markdown 1. 参数说明必须对应其在路径中出现的顺序 2. 如缺少说明将会导致`npm run docs:dev`报错 3. 说明中的 `'` `"` 必须通过反斜杠转义 `\'` `\"` 4. 不必在说明中标注`可选 / 必选`,组件会根据路由`?`自动判断 - * 文档样例: + - 文档样例: 1. 无参数: @@ -408,11 +408,11 @@ ctx.state.data = { 结果预览: - *** + * * * - *** + * * * 2. 多参数: @@ -422,13 +422,14 @@ ctx.state.data = { 结果预览: - *** + * * * - *** + * * * - 3. 复杂说明支持 slot: + + 3. 复杂说明支持 slot: ```vue @@ -454,9 +455,9 @@ ctx.state.data = { *** -2. 请一定要注意把``的标签关闭! +1. 请一定要注意把``的标签关闭! -3. 执行 `npm run format` 自动标准化代码格式,提交代码,然后提交 pull request +2. 执行 `npm run format` 自动标准化代码格式,提交代码,然后提交 pull request ## 提交新的 RSSHub Radar 规则 @@ -572,9 +573,9 @@ ctx.state.data = { [RSSBud](https://github.com/Cay-Zhang/RSSBud) 支持 RSSHub Radar 的规则并且也会自动更新,但是请注意: -* 在 Radar 的规则中使用 `'.'` 子域名可以让 RSSBud 适配 `m` / `mobile` 等常见移动端子域名 +- 在 Radar 的规则中使用 `'.'` 子域名可以让 RSSBud 适配 `m` / `mobile` 等常见移动端子域名 -* 在 `target` 中使用 `document` 的规则并不适用 RSSBud:RSSBud 并不是一个浏览器插件,他只获取并分析网站的 URL +- 在 `target` 中使用 `document` 的规则并不适用 RSSBud:RSSBud 并不是一个浏览器插件,他只获取并分析网站的 URL ### 补充文档 diff --git a/docs/journal.md b/docs/journal.md index 2612df064..e6afbbc34 100644 --- a/docs/journal.md +++ b/docs/journal.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 科学期刊 @@ -94,10 +94,10 @@ | nmat | Nature Materials | [/nature/research/nmat](https://rsshub.app/nature/research/nmat) | | natmachintell | Nature Machine Intelligence | [/nature/research/natmachintell](https://rsshub.app/nature/research/natmachintell) | -* 通过 `/nature/research/` + “杂志简写” 来获取对应杂志的最新文章(Latest Research)。 +- 通过 `/nature/research/` + “杂志简写” 来获取对应杂志的最新文章(Latest Research)。 若参数置空(`/nature/research`),则默认获取主刊(Nature)的最新文章。 -* 由于 Nature 系列的刊物是分别由不同的编辑来独立运营,所以页面格式上有些差异。目前**仅**对以下杂志进行了测试。 -* 由于权限的限制,目前仅获取论文的摘要进行展示。 +- 由于 Nature 系列的刊物是分别由不同的编辑来独立运营,所以页面格式上有些差异。目前**仅**对以下杂志进行了测试。 +- 由于权限的限制,目前仅获取论文的摘要进行展示。 @@ -116,9 +116,9 @@ | nmat | Nature Materials | [/nature/news-and-comment/nmat](https://rsshub.app/nature/news-and-comment/nmat) | | natmachintell | Nature Machine Intelligence | [/nature/news-and-comment/natmachintell](https://rsshub.app/nature/news-and-comment/natmachintell) | -* 通过 `/nature/research/` + “杂志简写” 来获取对应杂志的最新文章(Latest Research)。 +- 通过 `/nature/research/` + “杂志简写” 来获取对应杂志的最新文章(Latest Research)。 主刊由于格式不同,该 router 并未支持,采用 `/nature/news` 来获取新闻。 -* 由于 Nature 系列的刊物是分别由不同的编辑来独立运营,所以页面格式上有些差异。目前**仅**对以下杂志进行了测试。 +- 由于 Nature 系列的刊物是分别由不同的编辑来独立运营,所以页面格式上有些差异。目前**仅**对以下杂志进行了测试。 @@ -144,7 +144,7 @@ -* 通过 `/pnas/` + “领域名称” 来获取对应 “领域” 的最新文章(Latest Research)。 +- 通过 `/pnas/` + “领域名称” 来获取对应 “领域” 的最新文章(Latest Research)。 若参数置空(`/pnas`)或为 latest(`/pnas/latest`),则默认获取全部文章。 @@ -170,7 +170,7 @@ | stke | Science Signaling | [/sciencemag/current/stke](https://rsshub.app/sciencemag/current/stke) | | stm | Science Translational Medicine | [/sciencemag/current/stm](https://rsshub.app/sciencemag/current/stm) | -* 通过 `/sciencemag/current/` + “杂志简写” 来获取对应杂志最新一期的文章(Current Issue)。 +- 通过 `/sciencemag/current/` + “杂志简写” 来获取对应杂志最新一期的文章(Current Issue)。 若参数置空(`/sciencemag/current`),则默认获取主刊(Science)的最新文章。 @@ -189,7 +189,7 @@ -*仅支持 Science 主刊* +_仅支持 Science 主刊_ @@ -215,7 +215,7 @@ 1. 简单模式,例如「data visualization」, . -2. 高级模式,前往 [Google Scholar](https://scholar.google.com/schhp?hl=zh-cn\&as_sdt=0,5), 点击左上角,选择高级搜索并提交查询。此时 URL 应为: , 复制`https://scholar.google.com/scholar?`后的所有语句作为本路由的查询参数。例子所对应的完整路由为. +2. 高级模式,前往 [Google Scholar](https://scholar.google.com/schhp?hl=zh-cn&as_sdt=0,5), 点击左上角,选择高级搜索并提交查询。此时 URL 应为: , 复制`https://scholar.google.com/scholar?`后的所有语句作为本路由的查询参数。例子所对应的完整路由为. diff --git a/docs/live.md b/docs/live.md index b635d4aca..137deefb7 100644 --- a/docs/live.md +++ b/docs/live.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 直播 diff --git a/docs/multimedia.md b/docs/multimedia.md index e45895b4b..46f1db237 100644 --- a/docs/multimedia.md +++ b/docs/multimedia.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 音视频 @@ -58,7 +58,7 @@ ::: tip 提示 -由于 BT 之家域名有多个。此 feed 对应<`https://www.88btbtt.com`>域名和<`http://www.2btjia.com/`>域名. +由于 BT 之家域名有多个。此 feed 对应[`https://www.88btbtt.com`](https://www.88btbtt.com)域名和[`http://www.2btjia.com/`](http://www.2btjia.com/)域名. 可空,默认为 base ::: @@ -357,23 +357,23 @@ **示例说明** -* `/onejav/new` +- `/onejav/new` 仅当类型为 `new` `popular` 或 `random` 时关键词可为 **空** -* `/onejav/popular/30` +- `/onejav/popular/30` `popular` `random` 类型的关键词可填写 `7` `30` 或 `60` 三个 **日期范围** 之一 -* `/onejav/actress/Yua%20Mikami` +- `/onejav/actress/Yua%20Mikami` `actress` 类型的关键词必须填写 **演员名** ,可在 [此处](https://onejav.com/actress/) 演员单页链接中获取 -* `/onejav/tag/Adult%20Awards` +- `/onejav/tag/Adult%20Awards` `tag` 类型的关键词必须填写 **标签名** 且标签中的 `/` 必须替换为 `%2F` ,可在 [此处](https://onejav.com/tag/) 标签单页链接中获取 -* `/onejav/day/20200730` +- `/onejav/day/20200730` `day` 类型的关键词必须填写 **日期** ,按照示例写成形如 `20200730` 的格式 @@ -429,7 +429,7 @@ -> 注意:并非所有的分区都有子类型,可以参考亚洲成人有码原创区的 \[字幕] 这一子类型。 +> 注意:并非所有的分区都有子类型,可以参考亚洲成人有码原创区的[字幕]这一子类型。 | 亚洲成人无码原创区 | 亚洲成人有码原创区 | 欧美无码原创区 | 欧美无码区 | 亚洲有码薄码区 | | ------------------ | ------------------ | -------------- | ---------- | -------------- | @@ -475,7 +475,7 @@ -> 注意:并非所有的分区都有子类型,可以参考成人文学交流区的 \[古典武侠] 这一子类型。 +> 注意:并非所有的分区都有子类型,可以参考成人文学交流区的[古典武侠]这一子类型。 | 亚洲无码原创区 | 亚洲有码原创区 | 欧美原创区 | 动漫原创区 | 国产原创区 | | -------------- | -------------- | ---------- | ---------- | ---------- | @@ -684,8 +684,8 @@ 目前支持泛用型播客订阅的[输出格式](https://docs.rsshub.app/#输出格式)中标明的格式只有 rss 支持,也就是说你**只能使用**以下类型的链接来订阅播客: -* `https://rsshub.app/ximalaya/album/*` -* `https://rsshub.app/ximalaya/album/*.rss` +- `https://rsshub.app/ximalaya/album/*` +- `https://rsshub.app/ximalaya/album/*.rss` ::: diff --git a/docs/new-media.md b/docs/new-media.md index bf4307efc..411923b3c 100644 --- a/docs/new-media.md +++ b/docs/new-media.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 新媒体 @@ -390,13 +390,13 @@ Tag -* 可选语言: +- 可选语言: | 简体中文 | 正体中文 | 英语 | | -------- | -------- | ---- | | zh | zh_tw | en | -* 可选话题(按语言分类): +- 可选话题(按语言分类): | 语言 | | | | | | | | -------- | -------- | ----- | -------- | -------- | -------- | ------------ | @@ -404,9 +404,9 @@ Tag | 正体中文 | 最新文章 | 科普 | 測評報告 | 發燒入門 | 攝影入門 | 古典音樂入門 | | 英语 | Phone | Audio | Album | Review | | | -* Soomal 提供官方 RSS 订阅 - * Soomal 网站更新: - * Soomal 论坛与留言系统的更新: +- Soomal 提供官方 RSS 订阅 + - Soomal 网站更新: + - Soomal 论坛与留言系统的更新: @@ -458,8 +458,8 @@ Supported sub-sites: -* 频道为单一路径,如 则为 `/ifanr/coolbuy`. -* 频道包含多重路径,如 则替换 `/` 为 `-` `/ifanr/category-intelligentcar`. +- 频道为单一路径,如 则为 `/ifanr/coolbuy`. +- 频道包含多重路径,如 则替换 `/` 为 `-` `/ifanr/category-intelligentcar`. | AppSolution | 玩物志 | 董车会 | | ----------- | ------- | ----------------------- | @@ -625,7 +625,7 @@ area 分区选项 ::: tip 提示 -* 可以通过头条新闻 + 参数过滤的形式获得早报、专题等内容。 +- 可以通过头条新闻 + 参数过滤的形式获得早报、专题等内容。 ::: @@ -948,7 +948,7 @@ area 分区选项 | 网址 | 对应路由 | | ------------------------------------------------------------------------------------------------- | -------- | | kuai.media | /kuai | -| [www.kuai.media/portal.php?mod=list\&catid=38](http://www.kuai.media/portal.php?mod=list\&catid=38) | /kuai/38 | +| [www.kuai.media/portal.php?mod=list&catid=38](http://www.kuai.media/portal.php?mod=list&catid=38) | /kuai/38 | ## 快知 @@ -1389,7 +1389,7 @@ area 分区选项 只适用拥有首页模板 (分享链接带有 homepage) 的公众号。例如从公众号分享出来的链接为 ,`biz` 为 `MzA3MDM3NjE5NQ==`,`hid` 为 `4`。 -有些页面里会有分栏, `cid` 可以通过元素选择器选中栏目查看`data-index`。如[链接](https://mp.weixin.qq.com/mp/homepage?\__biz=MzA3MDM3NjE5NQ==\&hid=4)里的 `京都职人` 栏目的 `cid` 为 `0`,`文艺时光` 栏目的 `cid` 为 `2`。如果不清楚的话最左边的栏目为`0`,其右方栏目依次递增 `1`。 +有些页面里会有分栏, `cid` 可以通过元素选择器选中栏目查看`data-index`。如[链接](https://mp.weixin.qq.com/mp/homepage?__biz=MzA3MDM3NjE5NQ==&hid=4)里的 `京都职人` 栏目的 `cid` 为 `0`,`文艺时光` 栏目的 `cid` 为 `2`。如果不清楚的话最左边的栏目为`0`,其右方栏目依次递增 `1`。 @@ -1532,7 +1532,7 @@ area 分区选项 QueryString: -* `sort`:排序方式 +- `sort`:排序方式 | 根据创建时间(默认) | 根据回复时间 | 根据热度 | | -------------------- | ------------ | -------- | diff --git a/docs/other.md b/docs/other.md index dd38ca7f6..b7970b6e9 100644 --- a/docs/other.md +++ b/docs/other.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 其他 diff --git a/docs/parameter.md b/docs/parameter.md index b14a07f71..6fb7dc407 100644 --- a/docs/parameter.md +++ b/docs/parameter.md @@ -12,28 +12,28 @@ filter 选出想要的内容 -* filter: 过滤标题和描述 +- filter: 过滤标题和描述 -* filter_title: 过滤标题 +- filter_title: 过滤标题 -* filter_description: 过滤描述 +- filter_description: 过滤描述 -* filter_author: 过滤作者 +- filter_author: 过滤作者 -* filter_time: 过滤时间,仅支持数字,单位为秒。返回指定时间范围内的内容。如果条目没有输出`pubDate`或者格式不正确将不会被过滤 +- filter_time: 过滤时间,仅支持数字,单位为秒。返回指定时间范围内的内容。如果条目没有输出`pubDate`或者格式不正确将不会被过滤 -举例 1: `https://rsshub.app/bilibili/fav/2267573/801952073?filter=编曲|摄影`\ +举例 1: `https://rsshub.app/bilibili/fav/2267573/801952073?filter=编曲|摄影` 举例 2: filterout 去掉不要的内容 -* filterout: 过滤标题和描述 +- filterout: 过滤标题和描述 -* filterout_title: 过滤标题 +- filterout_title: 过滤标题 -* filterout_description: 过滤描述 +- filterout_description: 过滤描述 -* filterout_author: 过滤作者 +- filterout_author: 过滤作者 举例: `https://rsshub.app/bilibili/fav/2267573/801952073?filterout=编曲|摄影` @@ -65,7 +65,7 @@ filterout 去掉不要的内容 Telegram 即时预览模式需要在官网制作页面处理模板,请前往[官网](https://instantview.telegram.org/)了解更多 -* tgiv: 模板 hash,可从模板制作页面分享出来的链接末尾获取(`&rhash=`后面跟着的字符串) +- tgiv: 模板 hash,可从模板制作页面分享出来的链接末尾获取(`&rhash=`后面跟着的字符串) 举例: @@ -73,13 +73,13 @@ Telegram 即时预览模式需要在官网制作页面处理模板,请前往[ 可以输出 Sci-hub 链接,用于知名期刊或输出 DOI 的科学期刊类 RSS。 -* scihub: 任意值开启 +- scihub: 任意值开启 举例: ## 中文简繁体转换 -* opencc: s2t 简体转繁体、t2s 繁体转简体,其它可选值见 [OpenCC - Configurations](https://github.com/BYVoid/OpenCC#configurations-%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6) +- opencc: s2t 简体转繁体、t2s 繁体转简体,其它可选值见 [OpenCC - Configurations](https://github.com/BYVoid/OpenCC#configurations-%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6) 举例: @@ -89,7 +89,7 @@ RSSHub 同时支持 RSS 2.0 和 Atom 输出格式,在路由末尾添加 `.rss` 举例: -* 缺省 RSS 2.0 - -* RSS 2.0 - -* Atom - -* 和 filter 或其他 URL query 一起使用 `https://rsshub.app/bilibili/user/coin/2267573.atom?filter=微小微|赤九玖|暴走大事件` +- 缺省 RSS 2.0 - +- RSS 2.0 - +- Atom - +- 和 filter 或其他 URL query 一起使用 `https://rsshub.app/bilibili/user/coin/2267573.atom?filter=微小微|赤九玖|暴走大事件` diff --git a/docs/picture.md b/docs/picture.md index 50ea1abf6..b52bed09b 100644 --- a/docs/picture.md +++ b/docs/picture.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 图片 @@ -92,9 +92,9 @@ ::: tip 提示 -* tags 在 [konachan](https://konachan.com/post) URL 中 `tags=` 后的参数 -* 路由可选 `/konachan` 或 `/konachan.com` 或 `/konachan.net`, 其中前两者相同,`.net` 是全年龄健康的壁纸 ♡ -* 网站提供了 Posts 订阅: +- tags 在 [konachan](https://konachan.com/post) URL 中 `tags=` 后的参数 +- 路由可选 `/konachan` 或 `/konachan.com` 或 `/konachan.net`, 其中前两者相同,`.net` 是全年龄健康的壁纸 ♡ +- 网站提供了 Posts 订阅: ::: @@ -104,10 +104,10 @@ 举例: -* 过去 24 小时: -* 过去一周: -* 过去一月: -* 过去一年: +- 过去 24 小时: +- 过去一周: +- 过去一月: +- 过去一年: @@ -203,7 +203,7 @@ ::: tip 提示 -* 网站提供了 Posts 订阅: +- 网站提供了 Posts 订阅: ::: @@ -213,10 +213,10 @@ 举例: -* 过去 24 小时: -* 过去一周: -* 过去一月: -* 过去一年: +- 过去 24 小时: +- 过去一周: +- 过去一月: +- 过去一年: diff --git a/docs/program-update.md b/docs/program-update.md index 48853f922..5d1a62bbd 100644 --- a/docs/program-update.md +++ b/docs/program-update.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 程序更新 diff --git a/docs/programming.md b/docs/programming.md index d0490d166..9bde6b14e 100644 --- a/docs/programming.md +++ b/docs/programming.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 编程 @@ -72,10 +72,10 @@ GitHub 官方也提供了一些 RSS: -* 仓库 releases: `https://github.com/:owner/:repo/releases.atom` -* 仓库 commits: `https://github.com/:owner/:repo/commits.atom` -* 用户动态: `https://github.com/:user.atom` -* 专属动态: `https://github.com/:user.private.atom?token=:secret` (登录后在[仪表盘页面](https://github.com)找到 **Subscribe to your news feed** 字样即可) +- 仓库 releases: `https://github.com/:owner/:repo/releases.atom` +- 仓库 commits: `https://github.com/:owner/:repo/commits.atom` +- 用户动态: `https://github.com/:user.atom` +- 专属动态: `https://github.com/:user.private.atom?token=:secret` (登录后在[仪表盘页面](https://github.com)找到 **Subscribe to your news feed** 字样即可) ::: @@ -115,9 +115,9 @@ GitHub 官方也提供了一些 RSS: | -------- | -------- | -------- | --------------- | | `DIYgod` | `RSSHub` | `master` | `lib/router.js` | -> * **分支名**中如果有 `/` 等特殊字符需使用 urlencode 进行编码,通常 `/` 需要被替换成 `%2f` -> * **文件路径**中如果有特殊字符同样需使用 urlencode 进行编码,但文件路径可以正常识别 `/` 字符 -> * **文件路径**如果以 `.rss`, `.atom`, `.json` 结尾,需要将后缀中的 `.` 替换成 `%2e` +> - **分支名**中如果有 `/` 等特殊字符需使用 urlencode 进行编码,通常 `/` 需要被替换成 `%2f` +> - **文件路径**中如果有特殊字符同样需使用 urlencode 进行编码,但文件路径可以正常识别 `/` 字符 +> - **文件路径**如果以 `.rss`, `.atom`, `.json` 结尾,需要将后缀中的 `.` 替换成 `%2e` > > Reeder 订阅 `%2erss` 或类似后缀的时候会出错,此时再在路由后面加上 `.rss` 即可正常订阅 > > > > 如: `https://rsshub.app/github/file/DIYgod/RSSHub/master/lib/router%2ejs` 替换成 `https://rsshub.app/github/file/DIYgod/RSSHub/master/lib/router%2ejs.rss` 即可 @@ -413,8 +413,8 @@ GitHub 官方也提供了一些 RSS: -> * 极客时间专栏需要付费订阅,RSS 仅做更新提醒,不含付费内容. -> * 极客新闻不需要付费,可通过 RSS 订阅. +> - 极客时间专栏需要付费订阅,RSS 仅做更新提醒,不含付费内容. +> - 极客新闻不需要付费,可通过 RSS 订阅. ## 技术头条 diff --git a/docs/reading.md b/docs/reading.md index 4ecf7b4e6..f0b157826 100644 --- a/docs/reading.md +++ b/docs/reading.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 阅读 diff --git a/docs/shopping.md b/docs/shopping.md index 7634352ca..e646967ec 100644 --- a/docs/shopping.md +++ b/docs/shopping.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 购物 @@ -185,13 +185,13 @@ For instance, in -* 榜单类型 +- 榜单类型 | 好价品类榜 | 好价电商榜 | 海淘 TOP 榜 | 好文排行榜 | 好物排行榜 | | ---------- | ---------- | ----------- | ---------- | ---------- | | pinlei | dianshang | haitao | haowen | haowu | -* 榜单 ID +- 榜单 ID 好价品类榜 diff --git a/docs/social-media.md b/docs/social-media.md index 75aa90a09..1fb3b8516 100644 --- a/docs/social-media.md +++ b/docs/social-media.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 社交媒体 @@ -68,7 +68,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性 动画 -| MAD・AMV | MMD・3D | 短片・手书・配音 | 特摄 | 综合 | +| MAD·AMV | MMD·3D | 短片・手书・配音 | 特摄 | 综合 | | ------- | ------ | ---------------- | ---- | ---- | | 24 | 25 | 47 | 86 | 27 | @@ -86,7 +86,7 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性 音乐 -| 原创音乐 | 翻唱 | VOCALOID・UTAU | 电音 | 演奏 | MV | 音乐现场 | 音乐综合 | ~~OP/ED/OST~~ | +| 原创音乐 | 翻唱 | VOCALOID·UTAU | 电音 | 演奏 | MV | 音乐现场 | 音乐综合 | ~~OP/ED/OST~~ | | -------- | ---- | ------------- | ---- | ---- | --- | -------- | -------- | ------------- | | 28 | 31 | 30 | 194 | 59 | 193 | 29 | 130 | 54 | @@ -108,9 +108,9 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性 | -------- | -------- | ---- | -------- | -------- | ------------ | | 201 | 124 | 207 | 208 | 209 | 122 | -\~~ 科技~~ +~~科技~~ -| ~~ 演讲・公开课~~| ~~ 星海~~| ~~ 机械~~| ~~ 汽车~~| +| ~~演讲・公开课~~ | ~~星海~~ | ~~机械~~ | ~~汽车~~ | | ---------------- | -------- | -------- | -------- | | 39 | 96 | 98 | 176 | @@ -138,9 +138,9 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性 | ---- | ---- | ---- | ---- | ------ | | 157 | 158 | 164 | 159 | 192 | -\~~ 广告~~ +~~广告~~ -| ~~ 广告~~| +| ~~广告~~ | | -------- | | 166 | @@ -330,8 +330,8 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性 通常来说,各实例提供用户时间线的订阅源,如下: -* RSS: `https://**:instance**/users/**:username**.rss` -* Atom: ~~`https://**:instance**/users/**:username**.atom`~~ (仅 pawoo.net) +- RSS: `https://**:instance**/users/**:username**.rss` +- Atom: ~~`https://**:instance**/users/**:username**.atom`~~ (仅 pawoo.net) 例如: @@ -655,9 +655,9 @@ Tiny Tiny RSS 会给所有 iframe 元素添加 `sandbox="allow-scripts"` 属性 ::: tip 提示 -* **目前只支持整数型 id** -* 字母型的 id,可以通过头像图片链接来找到其整数型 id,图片命名规则`ul[userid]-*.jpg`或`u[userid]-*.jpg`,即取文件名中间的数字 -* 例如:用户 id: `MovieL`他的头像图片链接:`https://img1.doubanio.com/icon/ul1128221-98.jpg`他的整数型 id: `1128221` +- **目前只支持整数型 id** +- 字母型的 id,可以通过头像图片链接来找到其整数型 id,图片命名规则`ul[userid]-*.jpg`或`u[userid]-*.jpg`,即取文件名中间的数字 +- 例如:用户 id: `MovieL`他的头像图片链接:`https://img1.doubanio.com/icon/ul1128221-98.jpg`他的整数型 id: `1128221` ::: diff --git a/docs/study.md b/docs/study.md index 3c31b226e..cf82859bc 100644 --- a/docs/study.md +++ b/docs/study.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 学习 @@ -42,17 +42,17 @@ ### 查询国内外 CTF 赛事信息 + path="/ctfhub/calendar/:limit?/:form?/:class?/:title?" + :paramsDesc="['通过CTF赛事名称过滤', '一个整数,筛选最近的limit场比赛', '比赛形式', '比赛类型']"> | `:class` | 类型 | | :------: | -------------------------------- | -| 0 | Jeopardy \[解题] | -| 1 | Attack with Defense \[AwD 攻防] | -| 2 | Robo Hacking Game \[RHG AI 自动化] | -| 3 | Real World \[RW 真实世界] | -| 4 | King of The Hill \[KoH 抢占山头] | -| 5 | Mix \[混合] | +| 0 | Jeopardy[解题] | +| 1 | Attack with Defense[AwD 攻防] | +| 2 | Robo Hacking Game[RHG AI 自动化] | +| 3 | Real World[RW 真实世界] | +| 4 | King of The Hill[KoH 抢占山头] | +| 5 | Mix[混合] | > class 以 的返回结果为准 @@ -350,11 +350,11 @@ | `:type` | 类别名称 | | ------------- | -------- | -| ~~multiple~~ | ~~ 综合~~| +| ~~multiple~~ | ~~综合~~ | | company | 公司 | | product | 产品 | | technology | 技术 | -| ~~character~~ | ~~ 人物~~| +| ~~character~~ | ~~人物~~ | | policy | 政策 | > 参数置空(`/zhishifenzi/innovation`)获取所有类别 diff --git a/docs/support/README.md b/docs/support/README.md index dcfdd9c82..b36237ebf 100644 --- a/docs/support/README.md +++ b/docs/support/README.md @@ -1,6 +1,6 @@ -*** - -## sidebar: auto +--- +sidebar: auto +--- # 支持 RSSHub @@ -12,14 +12,14 @@ RSSHub 是采用 MIT 许可的开源项目,使用完全免费。但是随着 周期性赞助可以获得额外的回报,比如更快的 GitHub 响应或者你的名字会出现在 RSSHub 的 GitHub 仓库和现在我们的官网中. -* 通过 [Patreon](https://www.patreon.com/DIYgod) 赞助 -* 通过 [爱发电](https://afdian.net/@diygod) 赞助 -* 给我们发邮件联系赞助事宜: +- 通过 [Patreon](https://www.patreon.com/DIYgod) 赞助 +- 通过 [爱发电](https://afdian.net/@diygod) 赞助 +- 给我们发邮件联系赞助事宜: [i@diygod.me](mailto:i@diygod.me) ## 一次性赞助 我们通过以下方式接受赞助: -* [微信支付](https://i.loli.net/2019/03/23/5c950ebbc373e.png) -* [支付宝](https://i.loli.net/2019/03/23/5c950ebbc980e.png) -* [Paypal](https://www.paypal.me/DIYgod) +- [微信支付](https://i.loli.net/2019/03/23/5c950ebbc373e.png) +- [支付宝](https://i.loli.net/2019/03/23/5c950ebbc980e.png) +- [Paypal](https://www.paypal.me/DIYgod) diff --git a/docs/traditional-media.md b/docs/traditional-media.md index dbbceadb4..1ab463a0f 100644 --- a/docs/traditional-media.md +++ b/docs/traditional-media.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 传统媒体 @@ -40,8 +40,8 @@ 支持大部分频道,频道名称见[BBC 官方 RSS](https://www.bbc.co.uk/news/10628494)。 -* 频道为单一路径,如 `https://feeds.bbci.co.uk/news/business/rss.xml` 则为 `/bbc/business`. -* 频道包含多重路径,如 `https://feeds.bbci.co.uk/news/world/asia/rss.xml` 则替换 `/` 为 `-` `/bbc/world-asia`. +- 频道为单一路径,如 `https://feeds.bbci.co.uk/news/business/rss.xml` 则为 `/bbc/business`. +- 频道包含多重路径,如 `https://feeds.bbci.co.uk/news/world/asia/rss.xml` 则替换 `/` 为 `-` `/bbc/world-asia`. @@ -51,15 +51,15 @@ 通过提取文章全文,以提供比官方源更佳的阅读体验. -支持大部分频道,频道名称见[BBC 中文网官方 RSS](https://www.bbc.com/zhongwen/simp/services/2009/09/000000\_rss)。 +支持大部分频道,频道名称见[BBC 中文网官方 RSS](https://www.bbc.com/zhongwen/simp/services/2009/09/000000_rss)。 简体版: -* 频道,如金融财经 `http://www.bbc.co.uk/zhongwen/simp/business/index.xml` 则为 `/bbc/chinese/business`. +- 频道,如金融财经 `http://www.bbc.co.uk/zhongwen/simp/business/index.xml` 则为 `/bbc/chinese/business`. 繁体版: -* 频道,如金融财经 `http://www.bbc.co.uk/zhongwen/trad/business/index.xml` 则为 `/bbc/traditionalchinese/business`. +- 频道,如金融财经 `http://www.bbc.co.uk/zhongwen/trad/business/index.xml` 则为 `/bbc/traditionalchinese/business`. @@ -105,8 +105,8 @@ ::: tip 提示 -* 不支持付费文章. -* 由于未知原因 FT 中文网的 SSL 证书不被信任 (参见[SSL Labs 报告](https://www.ssllabs.com/ssltest/analyze.html?d=www.ftchinese.com\&latest)), 所有文章通过 http 协议获取. +- 不支持付费文章. +- 由于未知原因 FT 中文网的 SSL 证书不被信任 (参见[SSL Labs 报告](https://www.ssllabs.com/ssltest/analyze.html?d=www.ftchinese.com&latest)), 所有文章通过 http 协议获取. ::: @@ -114,8 +114,8 @@ 支持所有频道,频道名称见[官方频道 RSS](http://www.ftchinese.com/channel/rss.html). -* 频道为单一路径,如 `http://www.ftchinese.com/rss/news` 则为 `/ft/chinese/news`. -* 频道包含多重路径,如 `http://www.ftchinese.com/rss/column/007000002` 则替换 `/` 为 `-` `/ft/chinese/column-007000002`. +- 频道为单一路径,如 `http://www.ftchinese.com/rss/news` 则为 `/ft/chinese/news`. +- 频道包含多重路径,如 `http://www.ftchinese.com/rss/column/007000002` 则替换 `/` 为 `-` `/ft/chinese/column-007000002`. @@ -135,7 +135,7 @@ Solidot 提供的 feed: -* +- ::: @@ -422,37 +422,37 @@ category 对应的关键词有 支持语言列表 -* 中国分站 `cn`: +- 中国分站 `cn`: - * 主频道: + - 主频道: | 深度分析 | 时事要闻 | 生活 | 投资 | | -------- | ----------- | ---- | --------- | | analyses | generalnews | life | investing | - * 资讯子频道: + - 资讯子频道: | 中国财经 | 国际财经 | 新闻人物 | 财经视点 | | -------- | --------------------- | --------- | -------- | | china | internationalbusiness | newsmaker | opinions | - * 专栏子频道: + - 专栏子频道: | 中国财经专栏 | 国际财经专栏 | 大宗商品专栏 | | ------------ | ------------ | ------------ | | CnColumn | IntColumn | ComColumn | -* 美国分站 `us`: +- 美国分站 `us`: - * 主频道: + - 主频道: | Business | Markets | World | Politics | Tech | Breakingviews | Wealth | Life | | -------- | ------- | ----- | -------- | ---------- | ------------- | ------ | --------- | | business | markets | world | politics | technology | breakingviews | wealth | lifestyle | -* 英国分站 `uk`: +- 英国分站 `uk`: - * 主频道: + - 主频道: | Business | Markets | World | UK | Tech | Money | Breakingviews | Sport | Life | | -------- | ------- | ----- | -- | ---------- | --------------- | ------------- | ------ | --------- | diff --git a/docs/travel.md b/docs/travel.md index 14b1f93dc..1fe24de18 100644 --- a/docs/travel.md +++ b/docs/travel.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 出行旅游 @@ -21,7 +21,7 @@ 1. 单个始发地,例如 「us+new york」, [https://rsshub.app/atfd/us+new york](https://rsshub.app/atfd/us+new%20york) 2. 逗号分隔多个始发地,例如 「us+new york, gb+london」, [https://rsshub.app/atfd/us+new york, gb+london/](https://rsshub.app/atfd/us+new%20york,gb+london/) -ISO 3166-1 国家代码列表请参见 [维基百科 ISO\_3166-1](https://zh.wikipedia.org/wiki/ISO\_3166-1) +ISO 3166-1 国家代码列表请参见 [维基百科 ISO_3166-1](https://zh.wikipedia.org/wiki/ISO_3166-1) @@ -35,7 +35,7 @@ ISO 3166-1 国家代码列表请参见 [维基百科 ISO\_3166-1](https://zh.wik 伦敦希思罗 ✈ 北京首都国际 -IATA 国际航空运输协会机场代码,参见[维基百科 国际航空运输协会机场代码](https://zh.wikipedia.org/wiki/%E5%9B%BD%E9%99%85%E8%88%AA%E7%A9%BA%E8%BF%90%E8%BE%93%E5%8D%8F%E4%BC%9A%E6%9C%BA%E5%9C%BA%E4%BB%A3%E7%A0%81\_\(A\)) +IATA 国际航空运输协会机场代码,参见[维基百科 国际航空运输协会机场代码](https://zh.wikipedia.org/wiki/%E5%9B%BD%E9%99%85%E8%88%AA%E7%A9%BA%E8%BF%90%E8%BE%93%E5%8D%8F%E4%BC%9A%E6%9C%BA%E5%9C%BA%E4%BB%A3%E7%A0%81_(A)) diff --git a/docs/university.md b/docs/university.md index adee8fa3f..3f59b93ea 100644 --- a/docs/university.md +++ b/docs/university.md @@ -1,6 +1,6 @@ -*** - -## pageClass: routes +--- +pageClass: routes +--- # 大学通知 @@ -964,7 +964,7 @@ jsjxy.hbut.edu.cn 证书链不全,自建 RSSHub 可设置环境变量 NODE_TLS | 教学服务 | 教学建设 | 学生培养 | 教学资源 | | ------------- | -------- | -------- | -------- | -| jxfw (default) | jxjs | xspy | jxzy | +| jxfw(default) | jxjs | xspy | jxzy | @@ -1060,7 +1060,7 @@ type 列表: 以[南信大信息公告栏](https://bulletin.nuist.edu.cn)为例,点开任意一个栏目 -获得 URL 中的**分域名**和**栏目编号(可选)**:https://`bulletin`.nuist.edu.cn/`791`/list.htm +获得 URL 中的**分域名**和**栏目编号(可选)**:https://`bulletin`.nuist.edu.cn/`791`/list.htm 将其替换到 RSS 路由地址中即可: