format: Part of fixing markdown format

[fwqaaq]

No description provided.

[fwqaaq]

已检查，并没有造成渲染问题

[jaywcjlove]

@jack-zhang-1314 这个 markdown 检查依赖编辑器插件？

我觉得应该是放到脚本中执行？每次提交的时候 lint 更改一下然后自动提交了

reference/.husky/pre-commit

Lines 1 to 4 in dbf8ac4

	#!/usr/bin/env sh
	. "$(dirname -- "$0")/_/husky.sh"
	npx --no-install lint-staged

[jaywcjlove]

@jack-zhang-1314 我发现了 prettier 其实已经有了 markdown 格式化的功能，只不过我注释掉了

只要修改两个地方

reference/package.json

Line 13 in 2b1d33a

"prettier": "prettier --write '**/*.{mjs,css,json,prettierrc,lintstagedrc}'"

上面脚本添加 md 文件匹配

-    "prettier": "prettier --write '**/*.{mjs,css,json,prettierrc,lintstagedrc}'"
+    "prettier": "prettier --write '**/*.{mjs,md,css,json,prettierrc,lintstagedrc}'"

再讲忽略里面的 docs 删除

reference/.prettierignore

Line 5 in 2b1d33a

docs

就可以运行 npm run prettier 进行格式化 markdown 文本文档。

注释这个有几个原因

1. 文档大标题 和二级标题转换了，禁止这种转换没有找到方法

大标题标识文本下行使用 === 不喜欢 文本前面使用 # 这样不能很好区分 页面标题

二级标题， 文本下行使用----。其它标题是用 #

Quick Reference 备忘清单
===

第一部分
----

### 卡片 1 (H3 部分)

### 卡片 2 (H3 部分)

### 卡片 3 (H3 部分)

第二部分
----

### 卡片 1 (H3 部分)

2. 第二个原因，注释配置不希望下面有换行

3. 第三个原因，表格更希望下面简单的

:- | -
:- | -
`-c`               | 紧凑而不是漂亮的输出
`-n`               | 使用`null`作为单个输

所以没有仔细找到对应 prettier 配置，所以注释了

@jack-zhang-1314 感谢你的努力，如果你找到了配置可以提个 PR

[fwqaaq]

是依赖编辑器插件的，但是有些错误并不能自动修复🤔，所以有些只能手动修改。并且部份错误修复会导致渲染问题，只能禁止。或者我们得配置自己的编写风格，格式统一会好一点。

[jaywcjlove]

@jack-zhang-1314 如果添加配置再添加 prettier VS 插件好像是可以的

但是这个在每次提交会格式化好进行提交。每次提交上去是格式化后的文本

[jaywcjlove]

@jack-zhang-1314 它不是手动的是自动的，使用 husky 在命令行提交(commit)前触发执行，使用 lint-staged 告诉 prettier 每次只格式化被你修改的 markdown 文件

[fwqaaq]

我明白你的意思，但是例如你的 color... 文件中的颜色，渲染时需要 ' '(代码快片段，手机打不出来)，如果你直接修复，就不能渲染出来

[fwqaaq]

@jack-zhang-1314 我发现了 prettier 其实已经有了 markdown 格式化的功能，只不过我注释掉了

只要修改两个地方

reference/package.json

Line 13 in 2b1d33a

"prettier": "prettier --write '**/*.{mjs,css,json,prettierrc,lintstagedrc}'"

上面脚本添加 md 文件匹配

-    "prettier": "prettier --write '**/*.{mjs,css,json,prettierrc,lintstagedrc}'"

+    "prettier": "prettier --write '**/*.{mjs,md,css,json,prettierrc,lintstagedrc}'"

再讲忽略里面的 docs 删除

reference/.prettierignore

Line 5 in 2b1d33a

docs

就可以运行 npm run prettier 进行格式化 markdown 文本文档。

注释这个有几个原因

1. 文档大标题 和二级标题转换了，禁止这种转换没有找到方法

大标题标识文本下行使用 === 不喜欢 文本前面使用 # 这样不能很好区分 页面标题

二级标题， 文本下行使用----。其它标题是用 #

Quick Reference 备忘清单

===



第一部分

----



### 卡片 1 (H3 部分)



### 卡片 2 (H3 部分)



### 卡片 3 (H3 部分)



第二部分

----



### 卡片 1 (H3 部分)

2. 第二个原因，注释配置不希望下面有换行

3. 第三个原因，表格更希望下面简单的

:- | -

:- | -

`-c`               | 紧凑而不是漂亮的输出

`-n`               | 使用`null`作为单个输

所以没有仔细找到对应 prettier 配置，所以注释了

@jack-zhang-1314 感谢你的努力，如果你找到了配置可以提个 PR

好的明天试试，🤔

[fwqaaq]

• 文档大标题 和二级标题转换了，禁止这种转换没有找到方法

• 二级标题， 文本下行使用 ----。其它标题是用 #

• 第二个原因，注释配置不希望下面有换行

• 第二个原因，注释配置不希望下面有换行

[fwqaaq]

我重新开一个吧

[jaywcjlove]

@jack-zhang-1314 这个是 GitHub GFM 标准 https://github.github.com/gfm/#example-50

==== -> #
----- -> ##

[fwqaaq]

@jaywcjlove ----- 对，但是部分 ----- 是当作 <hr> 使用，🤔 而且下划线的长度是不统一的