Skip to content

Commit 5a2b23c

Browse files
committed
feat: 移除markdown-cli模块,采用prettier校验文档格式
1 parent be2e584 commit 5a2b23c

File tree

164 files changed

+336
-541
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

164 files changed

+336
-541
lines changed

.markdownlint.js

Lines changed: 0 additions & 75 deletions
This file was deleted.

.markdownlintignore

Lines changed: 0 additions & 6 deletions
This file was deleted.

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -473,11 +473,9 @@ Nuxt.js是在vue框架上进行封装的,主要是用来解决单体页面的
473473
- [ ] 更了不起的Node.js - 狼书卷1
474474
- [ ] 了不起的Node.js
475475
- [ ] 分布式消息中间件实践
476-
...
477476

478477
### 非技术类
479478

480-
>
481479
> 主要是跟计算机无关的一些书,在看完之后,会选择性的进行思维导图、经典词句整理,也可能添加个人思考
482480
483481
- [ ] 你好孤独 - 陈果
@@ -489,12 +487,13 @@ Nuxt.js是在vue框架上进行封装的,主要是用来解决单体页面的
489487

490488
<!-- #endregion quick-start -->
491489

492-
[//]: # (宣传内容)
490+
[//]: # '宣传内容'
491+
493492
<!-- #region we-media -->
494493

495494
## 赞赏列表
496495

497-
以下排名不分先后! [传送门→]() **赞赏过的一定要微信跟我说呀!!!!!!**
496+
以下排名不分先后! [传送门→]() **赞赏过的一定要微信跟我说呀!!!!!!**
498497

499498
<div>
500499
<a href="https://github.com/ChiefPing" target="_blank" style="margin: 5px">

code/express/apps/apis-demo/Readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ express.Router()创建路由器对象时也支持一些额外的参数,查看
119119
- `mergeParams`:保留req.params父路由器的值,布尔类型。如果父级和子级的参数名称有冲突,则子级的值优先。默认false
120120
- `strict`:是否开始严格模式路由,布尔类型。默认false,即:`/test``/test/`效果一样
121121

122-
[//]: # (路由器的用途还有很多,不仅支持多种请求类型的接口定义,还能分层管理,后面将单独开一篇详细讲讲,传送门:[路由的使用]&#40;./路由的使用.md&#41;)
122+
[//]: # '路由器的用途还有很多,不仅支持多种请求类型的接口定义,还能分层管理,后面将单独开一篇详细讲讲,传送门:[路由的使用](./路由的使用.md)'
123123

124124
## application对象
125125

docker-compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# #
22
# 服务名: JavaScriptCollection
33
# IP范围: 172.30.0.200
4-
# #
4+
#
55
version: '2'
66
services:
77
JavaScriptCollection:

docs/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ features:
4242
link: /wechat-list.html
4343
---
4444

45-
[//]: # (<BiliBili bvid="BV1rd4y1V7tB" />)
46-
[//]: # (<XiGua id="7195198927220834868" />)
45+
[//]: # '<BiliBili bvid="BV1rd4y1V7tB" />'
46+
[//]: # '<XiGua id="7195198927220834868" />'
4747

4848
## 本地浏览【推荐】
4949

@@ -125,5 +125,6 @@ yarn run dev
125125
- Netlify: <https://js-collection.netlify.app>
126126
- Vercel: <https://js-collection.vercel.app>
127127

128-
[//]: # (自动引入首页)
128+
[//]: # '自动引入首页'
129+
129130
<!-- @include: ../README.md#we-media -->

docs/battle-interview/MySQL面试.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ show table status from database where name="tablename"
5656
- 日期类型:`Date``DateTime``TimeStamp``Time``Year`
5757
- 其他数据类型:`BINARY``VARBINARY``ENUM``SET``Geometry``Point``MultiPoint``LineString``MultiLineString``Polygon``GeometryCollection`
5858

59-
> BLOB和TEXT有什么区别? **字符串类型是:`SET``BLOB``ENUM``CHAR``TEXT``VARCHAR`**
59+
> BLOB和TEXT有什么区别? **字符串类型是:`SET``BLOB``ENUM``CHAR``TEXT``VARCHAR`**
6060
6161
- BLOB是一个二进制对象,可以容纳可变数量的数据。有四种类型的BLOB:TINYBLOB、BLOB、MEDIUMBLO和 LONGBLOB
6262
- TEXT是一个不区分大小写的BLOB。四种TEXT类型:TINYTEXT、TEXT、MEDIUMTEXT 和 LONGTEXT。
@@ -376,7 +376,7 @@ hash 分发,好处在于说,可以平均分配每个库的数据量和请求
376376

377377
> 为什么要分库?
378378
379-
数据库集群环境后都是多台 slave,基本满足了读取操作; 但是写入或者说大数据、频繁的写入操作对master性能影响就比较大,这个时候,单库并不能解决大规模并发写入的问题,所以就会考虑分库。
379+
数据库集群环境后都是多台 slave,基本满足了读取操作; 但是写入或者说大数据、频繁的写入操作对master性能影响就比较大,这个时候,单库并不能解决大规模并发写入的问题,所以就会考虑分库。
380380

381381
> 分库是什么?
382382

docs/battle-interview/Node面试.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ function throttle(func, wait) {
217217

218218
> 原理就是:会从middleware数组中取第一个函数开始执行,中间件函数中调用next方法就会去取下一个中间件函数继续执行。
219219
> 每个中间件函数执行完毕后都会返回一个promise对象。
220-
(ps:调用next方法并不是表示当前中间件函数执行完毕了,调用next之后仍可以继续执行其他代码)
220+
> (ps:调用next方法并不是表示当前中间件函数执行完毕了,调用next之后仍可以继续执行其他代码)
221221
222222
参考:<https://zhuanlan.zhihu.com/p/29455788>
223223

docs/battle-interview/后端汇总.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ permalink: /battle-interview/end-interview.html
55

66
# 后端汇总
77

8-
[//]: # (```mindmap)
9-
[//]: # (root&#40;思维导图&#41;)
10-
[//]: # ( test)
11-
[//]: # (```)
8+
[//]: # '```mindmap'
9+
[//]: # 'root(思维导图)'
10+
[//]: # ' test'
11+
[//]: # '```'

docs/battle-interview/接口幂等.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ permalink: /battle-interview/interface-idempotent.html
6161
## 如何做到幂等
6262

6363
- 有些接口本身就是幂等的,例如:
64+
6465
- 查询接口,在查询数据没有做变更的情况下,查询操作是幂等的
6566
- 删除操作一般会带有待删除数据的唯一标识,最终结果都是删除,也是幂等的
6667

@@ -69,7 +70,7 @@ permalink: /battle-interview/interface-idempotent.html
6970
- 在执行更新操作的时候,可以先查再决定是否更新,但这因为是非原子操作,所以在分布式系统中会存在问题。
7071
- `多版本控制`,更新操作时增加版本条件进行更新,例如: `update t_xxx set name=? where version< ?`
7172
- `状态机控制`,增加状态字段,状态可能是有先后顺序,例如:订单状态总是从待付款到已付款。
72-
也可能各个状态互相可以转化,例如:与第三方同步数据,同步状态可能从更新待同步直接就变成删除待同步了
73+
也可能各个状态互相可以转化,例如:与第三方同步数据,同步状态可能从更新待同步直接就变成删除待同步了
7374
- `定义去重表`,先在去重表中插入,成功执行后续操作
7475
- `悲观锁``select for update`
7576

docs/deploy-backup.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ const SupportScripts = {
4646
`,
4747
// 镜像存在即删除
4848
`
49-
if [ "$(docker images -q ${imageName} 2> /dev/null)" != "" ];then
49+
if [ "$(docker images -q ${imageName} 2> /dev/null)" != "" ];then
5050
docker rmi ${imageName}
5151
exit 0;
5252
else
@@ -66,10 +66,8 @@ const SupportScripts = {
6666
]
6767
}
6868

69-
7069
const deployName = process.argv[2]
7170

72-
7371
function getDeployCommand() {
7472
let deployCommand = SupportScripts.Ali
7573
// 部署到阿里云服务器
@@ -83,12 +81,10 @@ function getDeployCommand() {
8381
return deployCommand
8482
}
8583

86-
8784
// 执行
88-
;(async() => {
85+
;(async () => {
8986
const deployCommand = getDeployCommand()
9087
// console.log(deployCommand)
9188
await execShell(deployCommand)
9289
})()
93-
9490
```

docs/develop-skill/code-manager/git.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Git的使用
33
permalink: /develop-skill/code-manager/git.html
44
headerDepth: 2
55
---
6+
67
# Git的使用
78

89
**到目前为止,当今世界上使用最广泛的现代版本控制系统是 Git**。Git 是一个成熟的、积极维护的开源项目,最初由 Linux 操作系统内核的著名创建者 Linus Torvalds 于 2005 年开发。
@@ -27,7 +28,7 @@ Git 区域理解:
2728
- `远程仓库区`:也就是我们代码最终提交的归宿,没啥好说的。
2829

2930
- `远端分支本地副本`:这个其实主要储存了远程仓库各分支数据在本地的一个副本,
30-
你可以打开你 Git 项目下的 `.git` 文件,里面有个 `refs/remotes`,这里就主要存的就是远程仓库的分支信息,一般你执行 push 或者 pull、fetch 都会往这里进行更新。
31+
你可以打开你 Git 项目下的 `.git` 文件,里面有个 `refs/remotes`,这里就主要存的就是远程仓库的分支信息,一般你执行 push 或者 pull、fetch 都会往这里进行更新。
3132

3233
- `本地分支`:这里就是我们经常会打交道的区域,你在执行 commit 之后,本质上就是提交到了这个区域,你可以查看你的 `.git` 目录下的 `refs/heads` 目录,里面存的就是我们本地的分支代码信息。
3334

@@ -223,7 +224,7 @@ git branch -m <old-branch-name> <new-branch-name>
223224

224225
### 上游优先
225226

226-
- `master` 作为主分支 一般稳定版本
227+
- `master` 作为主分支 一般稳定版本
227228
- 其他分支皆从 `master` 分支`衍生`
228229
- 注意与传统分支策略区别
229230

@@ -253,7 +254,7 @@ git branch -m <old-branch-name> <new-branch-name>
253254
- `test`: 测试用例修改
254255
- `chore`: 其他修改, 比如构建流程, 依赖管理.
255256
- `scope`: commit 影响的范围, 比如: route, component, utils, build...
256-
- `subject`: commit 的概述, 建议符合 50/72 formatting
257+
- `subject`: commit 的概述, 建议符合 50/72 formatting
257258
- `body`: commit 具体修改内容, 可以分为多行, 建议符合 50/72 formatting
258259
- `footer`: 一些备注, 通常是 BREAKING CHANGE 或修复的 bug 的链接.
259260

@@ -275,7 +276,7 @@ Header部分只有一行,包括三个字段:type(必需)、scope(可
275276
- **fix:修补bug**
276277
- **docs:修改文档**
277278
- **style: 格式化代码结构(不影响代码运行的变动)**
278-
- **refactor:重构(即不是新增功能,也不是修改bug的代码变动,比如重命名变量 **
279+
- **refactor:重构(即不是新增功能,也不是修改bug的代码变动,比如重命名变量 )**
279280
- **chore:构建过程或辅助工具的变动(不会影响代码运行)**
280281

281282
**scope**

docs/develop-skill/code-manager/jenkins.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ docker-compose start jenkins
119119
## 使用
120120

121121
当Jenkins服务正常启动后,Jenkins默认暴露`8080``50000`两个端口,在浏览器中访问<http://127.0.0.1:8080即可Jenkins网站>
122+
122123
> 这里需要明白,Jenkins的端口也可以自定义或者进行端口映射
123124
124125
![浏览器访问Jenkins](images/jenkins-lock.png)

docs/develop-skill/code-style/eslint.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Eslint
33
permalink: /develop-skill/code-style/eslint.html
44
---
5+
56
# Eslint
67

78
## 基础使用

docs/front-end/base-begin/html.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ permalink: /front-end/base-begin/html-correlation.html
66
# HTML
77

88
HTML的全称为超文本标记语言,是一种标记语言。它包括一系列标签.通过这些标签可以将网络上的文档格式统一,使分散的Internet资源连接为一个逻辑整体。HTML文本是由HTML命令组成的描述性文本,HTML命令可以说明文字,图形、动画、声音、表格、链接等。
9-
超文本是一种组织信息的方式,它通过超级链接方法将文本中的文字、图表与其他信息媒体相关联。这些相互关联的信息媒体可能在同一文本中,也可能是其他文件,或是地理位置相距遥远的某台计算机上的文件。这种组织信息方式将分布在不同位置的信息资源用随机方式进行连接,为人们查找,检索信息提供方便 [ ] [百度百科](https://baike.baidu.com/item/HTML/97049)
9+
超文本是一种组织信息的方式,它通过超级链接方法将文本中的文字、图表与其他信息媒体相关联。这些相互关联的信息媒体可能在同一文本中,也可能是其他文件,或是地理位置相距遥远的某台计算机上的文件。这种组织信息方式将分布在不同位置的信息资源用随机方式进行连接,为人们查找,检索信息提供方便 [ ] [百度百科](https://baike.baidu.com/item/HTML/97049)
1010

1111
## 标题
1212

docs/front-end/base-begin/javascript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ creatObj.prototype.test = function () {
182182
- 原型的本质: 对象,`prototype`也可以称为原型对象
183183
- 原型的作用是:共享方法
184184

185-
### 对象原型__proto__
185+
### 对象原型**proto**
186186

187187
**对象都会有一个属性`__proto__`指向构造函数的`prototype`原型对象**
188188

@@ -206,7 +206,7 @@ console.log(obj.__proto__ === creatObj.prototype)
206206

207207
### 构造函数
208208

209-
对象原型`__proto__` 和 构造函数`prototype`原型对象里面都有一个`constructor`属性,`constructor`称为构造函数,是直接指向构造函数本身的
209+
对象原型`__proto__` 和 构造函数`prototype`原型对象里面都有一个`constructor`属性,`constructor`称为构造函数,是直接指向构造函数本身的
210210

211211
**用来记录该对象引用那个构造函数,可以让原型对象重新指向原来的构造函数**
212212

docs/front-end/front-framework/jquery.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: JQuery
33
permalink: /front-end/front-framework/jquery.html
44
---
5+
56
# jQuery
67

78
> 不推荐学,直接看官方文档,操作api方法即可

docs/front-end/front-framework/nuxt.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
title: Nuxt.js
33
permalink: /front-end/front-framework/nuxt.html
44
---
5+
56
# Nuxt.js

docs/front-end/front-framework/vue.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
title: Vue框架
33
permalink: /front-end/front-framework/vue.html
44
---
5+
56
# Vue框架

docs/front-end/ui-framework/ant-design-vue.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
title: Ant-Design-Vue
33
permalink: /front-end/ui-framework/ant-design-vue.html
44
---
5+
56
# Ant-Design-Vue

docs/job-chance/job-poster-bytedance.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ title: 字节跳动
33
permalink: /job-chance/job-poster-bytedance.html
44
headerDepth: 1
55
---
6+
67
# 字节跳动内推
78

89
> 帮朋友转发、宣传一下jd是相对社招而言,校招、实习会降低要求!社招、校招、实习机会多多,更有漂亮hr小姐姐引导整个流程;
9-
不论是在校学生还是已步入职场的你,只要有兴趣,给我简历即安排内推。欢迎简历骚扰,备注来意即可,邮箱:<mmdapl@163.com>
10+
> 不论是在校学生还是已步入职场的你,只要有兴趣,给我简历即安排内推。欢迎简历骚扰,备注来意即可,邮箱:<mmdapl@163.com>
1011
1112
## 资深前端开发工程师 - 抖音电商
1213

@@ -106,7 +107,7 @@ headerDepth: 1
106107
- 计算机基础扎实,熟练掌握Javascript,ES5/6,CSS,熟练掌握各种布局;
107108
- 对解决 CSS/JS 多浏览器兼容性问题,前端性能优化有一定的经验;
108109
- 理解工程化思想,对构建和持续集成有一定认识,熟悉一种构建工具;
109-
- 理解组件化开发思想,有一定的设计能力,熟悉最少一种前端MV*框架;
110+
- 理解组件化开发思想,有一定的设计能力,熟悉最少一种前端MV\*框架;
110111
- 对后端技术和数据库有一定了解;
111112
- 有移动端web开发经验(Hybrid,React Native等)优先;
112113
- 对大型网站重构有丰富经验者优先,有成功作品者优先;

0 commit comments

Comments
 (0)