remark

skt041959 · May 3, 2020 · 02b1c9f · 02b1c9f
1 parent 556f686
commit 02b1c9f
Show file tree

Hide file tree

Showing 25 changed files with 426 additions and 311 deletions.
diff --git a/docs/.format/chineseFormat.js b/docs/.format/chineseFormat.js
@@ -6,25 +6,27 @@ const frontmatter = require('remark-frontmatter');
 
 const consistent = require('remark-preset-lint-consistent');
 const styleGuide = require('remark-preset-lint-markdown-style-guide');
-//const recommended = require('remark-preset-lint-recommended');
+const recommended = require('remark-preset-lint-recommended');
 const prettier = require('remark-preset-prettier');
 
 // Helpers
 
 module.exports = {
     rules: (list) => list.filter((e) => e.lang === file.LANG_CN),
-    handler: async (doc) =>
-        remark()
+    handler: async (doc) => {
+        let result = await remark()
             .use(frontmatter)
             .use(pangu)
             .use(consistent)
             .use(styleGuide)
-            // .use(recommended)
+            .use(recommended)
             .use(prettier)
             .use({
                 settings: {
                     stringLength: width,
                 },
             })
-            .process(doc),
+            .process(doc);
+        return typeof result === 'string' ? result : typeof result.contents === 'string' ? result.contents : result.result;
+    },
 };
diff --git a/docs/anime.md b/docs/anime.md
@@ -25,7 +25,7 @@ pageClass: routes
 ::: tip 提示
 
 番剧 id 不包含开头的 aa。
-例如：http://www.acfun.cn/bangumi/aa5022158 的番剧 id 是 5022158，不包括开头的 aa。
+例如：<http://www.acfun.cn/bangumi/aa5022158> 的番剧 id 是 5022158，不包括开头的 aa。
 
 :::
 
@@ -45,7 +45,7 @@ pageClass: routes
 
 <Route author="maple3142" example="/anime1/anime/2018年秋季/哥布林殺手" path="/anime1/anime/:time/:name" :paramsDesc="['时间', '动画名称']" radar="1">
 
-时间和动画名称请自己从网址取得: <https://anime1.me/category/2018年秋季/刀劍神域-alicization>
+时间和动画名称请自己从网址取得: [https://anime1.me/category/2018 年秋季 / 刀劍神域 - alicization](https://anime1.me/category/2018年秋季/刀劍神域-alicization)
 
 </Route>
 
@@ -115,9 +115,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>
 
@@ -196,7 +196,7 @@ pageClass: routes
 
 <Route author="machsix" path="/webtoons/:lang/:category/:name/:id" example="/webtoons/zh-hant/drama/gongzhuweimian/894" :paramsDesc="['语言','类别','名称','ID']"/>
 
-比如漫画公主彻夜未眠的网址为https://www.webtoons.com/zh-hant/drama/gongzhuweimian/list?title_no=894, 则`lang=zh-hant`,`category=drama`,`name=gongzhucheyeweimian`,`id=894`.
+比如漫画公主彻夜未眠的网址为<https://www.webtoons.com/zh-hant/drama/gongzhuweimian/list?title_no=894>, 则`lang=zh-hant`,`category=drama`,`name=gongzhucheyeweimian`,`id=894`.
 
 ### [Naver](https://comic.naver.com)
 
@@ -208,8 +208,8 @@ pageClass: routes
 
 <Route author="SunShinenny" path="/dilidili/fanju/:id" example="/dilidili/fanju/onepunchman2" :paramsDesc="['番剧id']">
 
-请打开对应番剧的纵览页(非具体某集),从 url 中最后一位查看番剧 id.(一般为英文)
-除去'海贼'此类具有特殊页面的超长番剧,绝大多数页面都可以解析.
+请打开对应番剧的纵览页 (非具体某集), 从 url 中最后一位查看番剧 id.(一般为英文)
+除去'海贼'此类具有特殊页面的超长番剧, 绝大多数页面都可以解析.
 最适合用来追新番
 
 </Route>

diff --git a/docs/api.md b/docs/api.md
@@ -18,7 +18,7 @@ RSSHub 提供下列 API 接口:
 
 参数:
 
--   name, 路由一级名称, 对应 [https://github.com/DIYgod/RSSHub/tree/master/lib/routes](https://github.com/DIYgod/RSSHub/tree/master/lib/routes) 中的文件夹名称. 可选, **缺省则返回所有可用路由**.
+-   name, 路由一级名称, 对应 <https://github.com/DIYgod/RSSHub/tree/master/lib/routes> 中的文件夹名称. 可选, **缺省则返回所有可用路由**.
 
 成功请求将会返回 HTTP 状态码 `200 OK` 与 JSON 结果, 格式如下:
 

diff --git a/docs/bbs.md b/docs/bbs.md
@@ -58,11 +58,11 @@ pageClass: routes
 
 ## Discuz
 
-### 通用子版块-自动检测
+### 通用子版块 - 自动检测
 
 <Route author="junfengP" example="/discuz/http%3a%2f%2fwww.u-share.cn%2fforum.php%3fmod%3dforumdisplay%26fid%3d56" path="/discuz/:link" :paramsDesc="['子版块链接， 需要手动Url编码']"/>
 
-### 通用子版块-指定版本
+### 通用子版块 - 指定版本
 
 <Route author="junfengP" example="/discuz/x/https%3a%2f%2fwww.52pojie.cn%2fforum-16-1.html" path="/discuz/:ver/:link" :paramsDesc="['discuz版本类型，见下表','子版块链接， 需要手动Url编码']" >
 
@@ -72,7 +72,7 @@ pageClass: routes
 
 </Route>
 
-### 通用子版块-支持 Cookie
+### 通用子版块 - 支持 Cookie
 
 <Route author="junfengP" example="/discuz/x/00/https%3a%2f%2fbbs.zdfx.net%2fforum-2-1.html" path="/discuz/:ver/:cid/:link" :paramsDesc="['discuz版本类型，见下表', 'Cookie id，需自建并配置环境变量，详情见部署页面的配置模块','子版块链接， 需要手动Url编码']" >
 
@@ -150,7 +150,7 @@ pageClass: routes
 
 ## V2EX
 
-### 最热/最新主题
+### 最热 / 最新主题
 
 <Route author="WhiteWorld" example="/v2ex/topics/latest" path="/v2ex/topics/:type" :paramsDesc="['hot 或 latest']"/>
 
@@ -304,12 +304,12 @@ pageClass: routes
 <Route author="NavePnow" example="/1point3acres/offer/12/null/CMU" path="/1point3acres/offer/:year?/:major?/:school?" :paramsDesc="['录取年份  id，空为null', '录取专业 id，空为null', '录取学校 id，空为null']">
 ::: warning 三个 id 获取方式
 
-1. 打开 https://offer.1point3acres.com
-2. 打开控制台
-3. 切换到 Network 面板
-4. 点击 搜索 按钮
-5. 点击 results?ps=15&pg=1 POST 请求
-6. 找到 Request Payload 请求参数，例如 filters: {planyr: "13", planmajor: "1", outname_w: "ACADIAU"} ，则三个 id 分别为: 13,1,ACADIAU
+1.  打开 <https://offer.1point3acres.com>
+2.  打开控制台
+3.  切换到 Network 面板
+4.  点击 搜索 按钮
+5.  点击 results?ps=15&pg=1 POST 请求
+6.  找到 Request Payload 请求参数，例如 filters: {planyr: "13", planmajor: "1", outname_w: "ACADIAU"} ，则三个 id 分别为: 13,1,ACADIAU
 
 :::
 </Route>

diff --git a/docs/blog.md b/docs/blog.md
@@ -24,7 +24,7 @@ pageClass: routes
 | ----------------- | ------------------- | -------- | -------- | --------------- | -------- | -------------- |
 | hirasawayui       | se7en               | walnut   | themez   | comeet          | sunskyxh | zmd            |
 
-> 原则上只要是{type}.hedwig.pub 都可以匹配。
+> 原则上只要是 {type}.hedwig.pub 都可以匹配。
 
 ## Hexo
 

diff --git a/docs/design.md b/docs/design.md
@@ -10,7 +10,7 @@ pageClass: routes
 
 <Route author="MisteryMonster" example="/axis-studios/work/full-service-cg-production" path="/axis-studios/:type/:tag?" :paramsDesc="['`work`, `blog`','文章内的 Work type URL: `compositing`, `full-service-cg-production`, `vfx-supervision`, `realtime`, `art-direction`, `animation`']">
 
-文章内 Work type 指向的栏目地址，比如： 'https://axisstudiosgroup.com/work/full-service-cg-production' 的 tag 为 `full-service-cg-production`，要注意的是 tag 和文章的目录是一样的。
+文章内 Work type 指向的栏目地址，比如： '<https://axisstudiosgroup.com/work/full-service-cg-production'> 的 tag 为 `full-service-cg-production`，要注意的是 tag 和文章的目录是一样的。
 
 有一些 tag 并不经常使用： `Script`, `direction`, `production`, `design-concept` 等等。
 
@@ -63,7 +63,7 @@ pageClass: routes
 
 不支持`news`和`main`。
 
-默认为 'https://www.methodstudios.com/en/features' 下的栏目。
+默认为 '<https://www.methodstudios.com/en/features'> 下的栏目。
 
 </Route>
 

diff --git a/docs/game.md b/docs/game.md
@@ -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`:
 
@@ -134,7 +134,7 @@ pageClass: routes
 
 </Route>
 
-### PlayStation Store 游戏折扣|价格
+### PlayStation Store 游戏折扣 | 价格
 
 <Route author="MisteryMonster" example="/ps/product/UP9000-CUSA00552_00-THELASTOFUS00000" path="/ps/:lang/product/:gridName" :paramsDesc="['地区语言','游戏的 grid 名']" radar="1">
 
@@ -156,11 +156,11 @@ pageClass: routes
 
 ## psnine
 
-### 首页-白金攻略/游戏开箱
+### 首页 - 白金攻略 / 游戏开箱
 
 <Route author="LightStrawberry" example="/psnine/index" path="/psnine/index"/>
 
-### 新闻-游戏资讯
+### 新闻 - 游戏资讯
 
 <Route author="LightStrawberry" example="/psnine/news" path="/psnine/news"/>
 ### 数折-折扣信息推送
@@ -214,9 +214,9 @@ Example: `https://store.steampowered.com/search/?specials=1&term=atelier` 中的
 
 <Route author="dearrrfish" example="/steamdb/free" path="/steamdb/free/:type?" :paramsDesc="['免费类型，留空为不过滤']"/>
 
-| 全部   | 周末    | 永久 |
-| ------ | ------- | ---- |
-| <留空> | weekend | keep |
+| 全部 | 周末    | 永久 |
+| ---- | ------- | ---- |
+| 留空 | weekend | keep |
 
 ## SteamGifts
 
@@ -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>
 
@@ -310,7 +310,7 @@ Example: `https://store.steampowered.com/search/?specials=1&term=atelier` 中的
 
 ## 米哈游
 
-### 崩坏 2-游戏公告
+### 崩坏 2 - 游戏公告
 
 <Route author="deepred5" example="/mihoyo/bh2/gach" path="/mihoyo/bh2/:type" :paramsDesc="['公告种类']">
 
@@ -320,7 +320,7 @@ Example: `https://store.steampowered.com/search/?specials=1&term=atelier` 中的
 
 </Route>
 
-### 崩坏 3-游戏公告
+### 崩坏 3 - 游戏公告
 
 <Route author="deepred5 nczitzk" example="/mihoyo/bh3/latest" path="/mihoyo/bh3/:type" :paramsDesc="['公告种类']">
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,7 +18,7 @@ RSSHub 提供下列 API 接口: @@
     参数:
-    -   name, 路由一级名称, 对应 [https://github.com/DIYgod/RSSHub/tree/master/lib/routes](https://github.com/DIYgod/RSSHub/tree/master/lib/routes) 中的文件夹名称. 可选, **缺省则返回所有可用路由**.
+    -   name, 路由一级名称, 对应 <https://github.com/DIYgod/RSSHub/tree/master/lib/routes> 中的文件夹名称. 可选, **缺省则返回所有可用路由**.
     成功请求将会返回 HTTP 状态码 `200 OK` 与 JSON 结果, 格式如下:
@@ Expand Down @@