Skip to content

Commit 19594ae

Browse files
committed
fix: improve markdown formatting and add VSCode settings
1 parent ea42e8a commit 19594ae

28 files changed

+979
-185
lines changed

.markdownlint.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"default": true,
3+
"line-length": false,
4+
"no-trailing-punctuation": false,
5+
"first-line-heading": false,
6+
"commands-show-output": false,
7+
"single-trailing-newline": false,
8+
"no-emphasis-as-heading": false,
9+
"fenced-code-language": false,
10+
"no-inline-html": false
11+
}

.vscode/extensions.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"recommendations": [
3+
"davidanson.vscode-markdownlint"
4+
]
5+
}
6+
7+
8+
9+

.vscode/settings.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"[markdown]": {
3+
"editor.defaultFormatter": "DavidAnson.vscode-markdownlint",
4+
"editor.formatOnSave": true,
5+
"editor.formatOnPaste": true
6+
}
7+
}

README.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# 你的第一门用TS写Node.js入门课
22

3-
43
<div align="center">
54
<p>
65
<a href="https://npmstudy.github.io/Your-First-Node.js-with-TypeScript-Course/">

package.json

+4-2
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@
55
"scripts": {
66
"start": "mdbook serve -p 8000 --open",
77
"test": "echo \"Error: no test specified\" && exit 1",
8-
"deploy": "mdbook build && node publish.js"
8+
"deploy": "mdbook build && node publish.js",
9+
"lint:md": "markdownlint '**/*.md' --ignore node_modules --fix"
910
},
1011
"keywords": [],
1112
"author": "",
1213
"license": "ISC",
1314
"description": "",
1415
"devDependencies": {
15-
"gh-pages": "^6.3.0"
16+
"gh-pages": "^6.3.0",
17+
"markdownlint-cli": "^0.35.0"
1618
}
1719
}

0 commit comments

Comments
 (0)