xiaoxue_admin
/
RSSHub
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update

This commit is contained in:
DIYgod 2020-05-18 12:04:49 +08:00
parent 4c9516438c
commit 41bc394b08
No known key found for this signature in database
GPG Key ID: EC0B76A252D3EF67
12 changed files with 93 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/anime.md
View File

@ -114,9 +114,9 @@ pageClass: routes
<Route author="cssxsh" example="/dlsite/new/home" path="/dlsite/new/:type" :paramsDesc="['类型，如下表']">
| 同人 | 漫画 | 软件 | 同人 (R18) | 漫画 (R18) | 美少女游戏 | 乙女 | BL |
| ---- | ----- | ---- | ---------- | ---------- | ---------- | ----- | --- |
| home | comic | soft | maniax | books | pro | girls | bl |
| 同人 | 漫画 | 软件 | 同人 (R18) | 漫画 (R18) | 美少女游戏 | 乙女 | BL |
| ---- | ----- | ---- | ---------- | ---------- | ---------- | ----- | -- |
| home | comic | soft | maniax | books | pro | girls | bl |
</Route>

2
docs/en/new-media.md
View File

@ -71,6 +71,8 @@ Compared to the official one, the RSS feed generated by RSSHub not only has more
## Grub Street
### Posts
<RouteEn author="loganrockmore" example="/grubstreet" path="/grubstreet" />
## iDownloadBlog

12
docs/game.md
View File

@ -74,9 +74,9 @@ pageClass: routes
支持的主机平台:
| PS 4 | Xbox One | Switch | PC | Wii U | 3DS | PS Vita | iOS |
| ---- | -------- | ------ | --- | ----- | --- | ------- | --- |
| ps4 | xboxone | switch | pc | wii-u | 3ds | vita | ios |
| PS 4 | Xbox One | Switch | PC | Wii U | 3DS | PS Vita | iOS |
| ---- | -------- | ------ | -- | ----- | --- | ------- | --- |
| ps4 | xboxone | switch | pc | wii-u | 3ds | vita | ios |
发行类型，默认为 `new`:
@ -272,9 +272,9 @@ Example: `https://store.steampowered.com/search/?specials=1&term=atelier` 中的
<Route author="sintak" example="/gouhuo/news/switch" path="/gouhuo/news/:category" :paramsDesc="['资讯类型']">
| 精选 | 海外 | 原创 | PS4 | Xboxone | PC | Switch | 掌机 | 手游 | 新闻 | 评测 | 文化 | 视频 | 音频 | 折扣 |
| ---------- | -------- | ------- | --- | ------- | --- | ------ | -------- | ---------- | ---- | ------ | ------- | ----- | ----- | -------- |
| choiceness | overseas | orignal | ps4 | xboxone | pc | switch | handheld | mobilegame | news | review | culture | video | audio | discount |
| 精选 | 海外 | 原创 | PS4 | Xboxone | PC | Switch | 掌机 | 手游 | 新闻 | 评测 | 文化 | 视频 | 音频 | 折扣 |
| ---------- | -------- | ------- | --- | ------- | -- | ------ | -------- | ---------- | ---- | ------ | ------- | ----- | ----- | -------- |
| choiceness | overseas | orignal | ps4 | xboxone | pc | switch | handheld | mobilegame | news | review | culture | video | audio | discount |
</Route>

42
docs/government.md
View File

@ -12,7 +12,7 @@ pageClass: routes
| 委内新闻 | 基层动态 | 媒体聚焦 | 热点新闻 |
| :------: | :------: | :------: | :------: |
| wnxw | jcdt | mtjj | rdxws |
| wnxw | jcdt | mtjj | rdxws |
</Route>
@ -27,12 +27,12 @@ pageClass: routes
| 进口网络游戏审批信息 | importednetgame |
| 进口电子游戏审批信息 | importedvideogame |
| 国产网络游戏审批信息 | domesticnetgame |
| 游戏审批变更信息 | gamechange |
| 游戏审批变更信息 | gamechange |
| 描述 | detail |
| :------------------------------------: | :--------------: |
| 留空，返回栏目所有文章 | |
| new，返回栏目第一篇文章内容 | new |
| new，返回栏目第一篇文章内容 | new |
| 某个文章标题的一部分，返回这篇文章内容 | 例：2020 年 1 月 |
</Route>
@ -51,7 +51,7 @@ pageClass: routes
| 政务要闻 | 区县快讯 | 部门动态 | 新闻视频 | 热点专题 | 市本级专题 | 最新热点专题 | 往期专题 | 区县专题 | 政务公告 | 便民资讯 |
| :------: | :------: | :------: | :------: | :------: | :--------: | :----------: | :------: | :------: | :------: | :------: |
| news | district | bmdt | xwsp | rdzt | sbjzt | zxrdzt | wqzt | qxzt | zwgg | bmzx |
| news | district | bmdt | xwsp | rdzt | sbjzt | zxrdzt | wqzt | qxzt | zwgg | bmzx |
</Route>
@ -101,11 +101,11 @@ pageClass: routes
<Route author="ciaranchen" example="/gov/zhengce/govall/orpro=555&notpro=2&search_field=title" path="/gov/zhengce/govall/:advance?" :paramsDesc="['高级搜索选项，将作为请求参数直接添加到url后。目前已知的选项及其意义如下。' ]" >
| 选项 | 意义 | 备注 |
| 选项 | 意义 | 备注 |
| :-----------------------------: | :----------------------------------------------: | :----------------------------: |
| orpro | 包含以下任意一个关键词。 | 用空格分隔。 |
| allpro | 包含以下全部关键词 | |
| notpro | 不包含以下关键词 | |
| allpro | 包含以下全部关键词 | |
| notpro | 不包含以下关键词 | |
| inpro | 完整不拆分的关键词 | |
| searchfield | title: 搜索词在标题中；content: 搜索词在正文中。 | 默认为空，即网页的任意位置。 |
| pubmintimeYear, pubmintimeMonth | 从某年某月 | 单独使用月份参数无法只筛选月份 |
@ -120,7 +120,7 @@ pageClass: routes
| 政务部门 | 滚动新闻 | 新闻要闻 | 国务院新闻 | 政策文件 |
| :------: | :------: | :------: | :--------: | :------: |
| bm | gd | yw | gwy | zhengce |
| bm | gd | yw | gwy | zhengce |
</Route>
@ -146,13 +146,13 @@ pageClass: routes
<Route author="ocleo1" example="/gov/province/jiangsu/important-news" path="/gov/province/jiangsu/:category" :paramsDesc="['分类名']">
| 省政府常务会议 | 要闻关注 | 部门资讯 | 市县动态 | 政策解读 |
| 省政府常务会议 | 要闻关注 | 部门资讯 | 市县动态 | 政策解读 |
| :---------------: | :------------: | :--------: | :---------: | :-------------------: |
| executive-meeting | important-news | department | city-county | policy-interpretation |
| 政府信息公开年度报告 | 政府信息公开制度 | 省政府及办公厅文件 | 规范性文件 |
| 政府信息公开年度报告 | 政府信息公开制度 | 省政府及办公厅文件 | 规范性文件 |
| :------------------: | :-------------------: | :----------------: | :----------------: |
| annual-report | information-publicity | documentation | normative-document |
| annual-report | information-publicity | documentation | normative-document |
| 立法意见征集 | 意见征集 |
| :----------------------------: | :----------------: |
@ -181,9 +181,9 @@ pageClass: routes
<Route author="wolfyu1991" example="/gov/shanxi/rst/rsks-tzgg" path="/gov/shanxi/rst/:category" :paramsDesc="['分类名']">
| 通知公告 | 公务员考试 | 事业单位考试 | 专业技术人员资格考试 | 其他考试 |
| 通知公告 | 公务员考试 | 事业单位考试 | 专业技术人员资格考试 | 其他考试 |
| :-------: | :--------: | :----------: | :------------------: | :-------: |
| rsks-tzgg | rsks-gwyks | rsks-sydwks | rsks-zyjsryzgks | rsks-qtks |
| rsks-tzgg | rsks-gwyks | rsks-sydwks | rsks-zyjsryzgks | rsks-qtks |
</Route>
@ -233,7 +233,7 @@ pageClass: routes
| ------ | -------------------- |
| 慕尼黑 | `/embassy/de/munich` |
---
* * *
#### 法国 `FR`
@ -247,7 +247,7 @@ pageClass: routes
| 斯特拉斯堡 | `/embassy/fr/strasbourg` |
| 里昂 | `/embassy/fr/lyon` |
---
* * *
#### 日本 `JP`
@ -264,7 +264,7 @@ pageClass: routes
| 札幌 | `/embassy/jp/sapporo` |
| 新潟 | `/embassy/jp/niigata` |
---
* * *
#### 韩国 `KR`
@ -278,13 +278,13 @@ pageClass: routes
| 济州 | `/embassy/kr/jeju` |
| 光州 | `/embassy/kr/gwangju` |
---
* * *
#### 新加坡 `SG`
- 大使馆: `/embassy/sg`
---
* * *
#### 美国 `US`
@ -298,7 +298,7 @@ pageClass: routes
| 芝加哥 | `/embassy/us/chicago` |
| 旧金山 | `/embassy/us/sanfrancisco` |
---
* * *
#### 英国 `UK`
@ -324,7 +324,7 @@ pageClass: routes
<Route author="Crawler995" example="/gov/moe/policy_anal" path="/gov/moe/:type" :paramsDesc="['分类名']">
| 政策解读 | 最新文件 | 公告公示 | 教育部简报 |
| 政策解读 | 最新文件 | 公告公示 | 教育部简报 |
| :---------: | :---------: | :------: | :---------------: |
| policy_anal | newest_file | notice | edu_ministry_news |
@ -365,7 +365,7 @@ pageClass: routes
| 部内信息 | 政策解读 | 首页信息 |
| :------: | :------: | :------: |
| bnxx | zcjd | index |
| bnxx | zcjd | index |
</Route>

14
docs/joinus/README.md
View File

@ -269,7 +269,7 @@ sidebar: auto
至此我们完成了一个最简单的路由
---
* * *
#### 使用缓存
@ -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,7 +383,7 @@ ctx.state.data = {
};
```
---
* * *
### 添加脚本文档
@ -408,11 +408,11 @@ ctx.state.data = {
结果预览：
***
* * *
<Route author="HenryQW" example="/sspai/series" path="/sspai/series"/>
***
* * *
2. 多参数：
@ -422,11 +422,11 @@ ctx.state.data = {
结果预览：
***
* * *
<Route author="HenryQW" example="/github/issue/DIYgod/RSSHub" path="/github/issue/:user/:repo" :paramsDesc="['用户名', '仓库名']"/>
***
* * *
3. 复杂说明支持 slot:

36
docs/journal.md
View File

@ -10,10 +10,10 @@ pageClass: routes
<Route author="yech1990" example="/cell/cell/current" path="/journals/cell/cell/:category" supportScihub="1"/>
| `:category` | 类型说明 | 路由 |
| `:category` | 类型说明 | 路由 |
| :---------: | :-----------------: | ---------------------------------------------------------- |
| current | 本期刊物 (默认选项) | [/cell/cell/current](https://rsshub.app/cell/cell/current) |
| inpress | 在线发表 | [/cell/cell/inpress](https://rsshub.app/cell/cell/inpress) |
| inpress | 在线发表 | [/cell/cell/inpress](https://rsshub.app/cell/cell/inpress) |
</Route>
@ -39,16 +39,16 @@ pageClass: routes
<Route author="yech1990" example="/nature/research/ng" path="/nature/research/:journal" :paramsDesc="['期刊名简写']" />
| `:journal` | 期刊名 | 路由 |
| `:journal` | 期刊名 | 路由 |
| :-----------: | :-------------------------: | ---------------------------------------------------------------------------------- |
| nature | Nature | [/nature/research/nature](https://rsshub.app/nature/research/nature) |
| nbt | Nature Biotechnology | [/nature/research/nbt](https://rsshub.app/nature/research/nbt) |
| nature | Nature | [/nature/research/nature](https://rsshub.app/nature/research/nature) |
| nbt | Nature Biotechnology | [/nature/research/nbt](https://rsshub.app/nature/research/nbt) |
| neuro | Nature Neuroscience | [/nature/research/neuro](https://rsshub.app/nature/research/neuro) |
| ng | Nature Genetics | [/nature/research/ng](https://rsshub.app/nature/research/ng) |
| ni | Nature Immunology | [/nature/research/ni](https://rsshub.app/nature/research/ni) |
| ng | Nature Genetics | [/nature/research/ng](https://rsshub.app/nature/research/ng) |
| ni | Nature Immunology | [/nature/research/ni](https://rsshub.app/nature/research/ni) |
| nmeth | Nature Method | [/nature/research/nmeth](https://rsshub.app/nature/research/nmeth) |
| nchem | Nature Chemistry | [/nature/research/nchem](https://rsshub.app/nature/research/nchem) |
| nmat | Nature Materials | [/nature/research/nmat](https://rsshub.app/nature/research/nmat) |
| nchem | Nature Chemistry | [/nature/research/nchem](https://rsshub.app/nature/research/nchem) |
| 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）。
@ -62,15 +62,15 @@ pageClass: routes
<Route author="yech1990" example="/nature/news-and-comment/ng" path="/nature/news-and-comment/:journal" :paramsDesc="['期刊名简写']" supportScihub="1"/>
| `:journal` | 期刊名 | 路由 |
| `:journal` | 期刊名 | 路由 |
| :-----------: | :-------------------------: | -------------------------------------------------------------------------------------------------- |
| nbt | Nature Biotechnology | [/nature/news-and-comment/nbt](https://rsshub.app/nature/news-and-comment/nbt) |
| nbt | Nature Biotechnology | [/nature/news-and-comment/nbt](https://rsshub.app/nature/news-and-comment/nbt) |
| neuro | Nature Neuroscience | [/nature/news-and-comment/neuro](https://rsshub.app/nature/news-and-comment/neuro) |
| ng | Nature Genetics | [/nature/news-and-comment/ng](https://rsshub.app/nature/news-and-comment/ng) |
| ni | Nature Immunology | [/nature/news-and-comment/ni](https://rsshub.app/nature/news-and-comment/ni) |
| ng | Nature Genetics | [/nature/news-and-comment/ng](https://rsshub.app/nature/news-and-comment/ng) |
| ni | Nature Immunology | [/nature/news-and-comment/ni](https://rsshub.app/nature/news-and-comment/ni) |
| nmeth | Nature Method | [/nature/news-and-comment/nmeth](https://rsshub.app/nature/news-and-comment/nmeth) |
| nchem | Nature Chemistry | [/nature/news-and-comment/nchem](https://rsshub.app/nature/news-and-comment/nchem) |
| nmat | Nature Materials | [/nature/news-and-comment/nmat](https://rsshub.app/nature/news-and-comment/nmat) |
| nchem | Nature Chemistry | [/nature/news-and-comment/nchem](https://rsshub.app/nature/news-and-comment/nchem) |
| 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）。
@ -120,12 +120,12 @@ pageClass: routes
| `:journal` | 期刊名 | 路由 |
| :--------: | :----------------------------: | ---------------------------------------------------------------------------------- |
| science | Science | [/sciencemag/current/science](https://rsshub.app/sciencemag/current/science) |
| science | Science | [/sciencemag/current/science](https://rsshub.app/sciencemag/current/science) |
| advances | Science Advances | [/sciencemag/current/advances](https://rsshub.app/sciencemag/current/advances) |
| immunology | Science Immunology | [/sciencemag/current/immunology](https://rsshub.app/sciencemag/current/immunology) |
| robotics | Science Robotics | [/sciencemag/current/robotics](https://rsshub.app/sciencemag/current/robotics) |
| 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) |
| 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`），则默认获取主刊（Science）的最新文章。

6
docs/multimedia.md
View File

@ -471,9 +471,9 @@ pageClass: routes
<Route author="minosss" example="/gaoqingla" path="/gaoqingla/:tag?" :paramsDesc="['标签tag，视频清晰度']" />
| 全部 | 蓝光 | 1080P | 720P | 3D | WEB-DL |
| ---- | ------ | ----- | ---- | --- | ------ |
| 留空 | bluray | 1080p | 720p | 3d | webdl |
| 全部 | 蓝光 | 1080P | 720P | 3D | WEB-DL |
| ---- | ------ | ----- | ---- | -- | ------ |
| 留空 | bluray | 1080p | 720p | 3d | webdl |
## 中国广播

18
docs/new-media.md
View File

@ -104,12 +104,18 @@ pageClass: routes
<Route author="JamesWDGu KeiLongW" example="/engadget/chinese" path="/engadget/:lang" :paramsDesc="['語言']">
| 繁體中文 | 簡體中文 | US | 日文 |
| -------- | -------- | --- | -------- |
| chinese | cn | us | japanese |
| 繁體中文 | 簡體中文 | US | 日文 |
| -------- | -------- | -- | -------- |
| chinese | cn | us | japanese |
</Route>
## Grub Street
### Posts
<Route author="loganrockmore" example="/grubstreet" path="/grubstreet" />
## iDownloadBlog
### blog
@ -281,9 +287,9 @@ pageClass: routes
Supported sub-sites:
| TV | Movies | Comedy | Music | TV Recaps | Books | Theater | Art | Awards | Video |
| --- | ------ | ------ | ----- | --------- | ----- | ------- | --- | ------ | ----- |
| tv | movies | comedy | music | tvrecaps | books | theater | art | awards | video |
| TV | Movies | Comedy | Music | TV Recaps | Books | Theater | Art | Awards | Video |
| -- | ------ | ------ | ----- | --------- | ----- | ------- | --- | ------ | ----- |
| tv | movies | comedy | music | tvrecaps | books | theater | art | awards | video |
</Route>

10
docs/other.md
View File

@ -583,9 +583,9 @@ type 为 all 时，category 参数不支持 cost 和 free
<Route author="luyuhuang" example="/remote-work/all" path="/remote-work/:caty?" :paramsDesc="['职位类型, 默认为全部职位']" radar="1">
| 所有职位 | 技术 | 设计 | 运营 | 产品 | 其他 | 市场 | 销售 |
| 所有职位 | 技术 | 设计 | 运营 | 产品 | 其他 | 市场 | 销售 |
| :------: | :---------: | :----: | :-------: | :-----: | :---: | :-------: | :---: |
| all | development | design | operation | product | other | marketing | sales |
| all | development | design | operation | product | other | marketing | sales |
</Route>
@ -597,9 +597,9 @@ type 为 all 时，category 参数不支持 cost 和 free
类型
| 全部文章 | 永久免费 | 限时折扣 | 限时免费 | PC | Mac | Android | UWP |
| -------- | -------- | -------- | -------- | --- | --- | ------- | --- |
| all | 311 | 309 | 310 | 8 | 50 | 17 | 312 |
| 全部文章 | 永久免费 | 限时折扣 | 限时免费 | PC | Mac | Android | UWP |
| -------- | -------- | -------- | -------- | -- | --- | ------- | --- |
| all | 311 | 309 | 310 | 8 | 50 | 17 | 312 |
</Route>

14
docs/programming.md
View File

@ -492,11 +492,15 @@ GitHub 官方也提供了一些 RSS:
订阅[全部板块资讯][osc_all]可以使用 <https://rsshub.app/oschina/news>
[osc_all]: https://www.oschina.net/news '开源中国 - 全部资讯'
[osc_gen]: https://www.oschina.net/news/industry '开源中国 - 综合资讯'
[osc_proj]: https://www.oschina.net/news/project '开源中国 - 软件更新资讯'
[osc_ind]: https://www.oschina.net/news/industry-news '开源中国 - 行业资讯'
[osc_pl]: https://www.oschina.net/news/programming '开源中国 - 编程语言资讯'
[osc_all]: https://www.oschina.net/news "开源中国 - 全部资讯"
[osc_gen]: https://www.oschina.net/news/industry "开源中国 - 综合资讯"
[osc_proj]: https://www.oschina.net/news/project "开源中国 - 软件更新资讯"
[osc_ind]: https://www.oschina.net/news/industry-news "开源中国 - 行业资讯"
[osc_pl]: https://www.oschina.net/news/programming "开源中国 - 编程语言资讯"
</Route>

12
docs/study.md
View File

@ -47,12 +47,12 @@ pageClass: routes
| `: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 以 <https://api.ctfhub.com/User_API/Event/getType> 的返回结果为准

2
docs/travel.md
View File

@ -35,7 +35,7 @@ ISO 3166-1 国家代码列表请参见 [维基百科 ISO_3166-1](https://zh.wiki
伦敦希思罗 ✈ 北京首都国际 <https://rsshub.app/hopper/1/LHR/PEK>
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))
</Route>