维护：增加Prettier和Git Hooks (#107)

* 添加prettier和git hook

* Fix lint

* Disable KaTeX

* Fix typo

* Add comment to markdownlint config
[skip ci]
[skip netlify]

* 从lint-stage移除markdownlint

* 修复大小写错误

* reorder settings

* 仅在本仓库触发部署，fork仓库跳过

Author: northword

.github/workflows/main.yml

@@ -19,7 +19,7 @@ jobs:
     uses: ./.github/workflows/build.yml
 
   deploy-gh-pages:
-    if: github.ref_name == 'main' && github.event_name == 'push'
+    if: github.ref_name == 'main' && github.event_name == 'push' && github.repository == 'zotero-chinese/wiki'
     needs:
       - lint
       - build

.gitignore

@@ -3,7 +3,7 @@ node_modules/
 package-lock.json
 # pnpm-lock.yaml
 
-src/.vuepress/.cache/
-src/.vuepress/.temp/
-src/.vuepress/dist/
+**/.vuepress/.cache/
+**/.vuepress/.temp/
+**/.vuepress/dist/
 **/.obsidian

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

.markdownlint.json

@@ -0,0 +1,106 @@
+{
+  // 定义文档中涉及的专有名词
+  "MD044": {
+    "code_blocks": false,
+    "html_elements": false,
+    "names": [
+      "Zotero",
+      "JavaScript",
+      "GitHub",
+      "WebDAV",
+      "Android",
+      "iOS",
+      "macOS",
+      "WPS",
+      "Word",
+      "ZotFile",
+      "Zotero Chinese"
+    ]
+  },
+
+  // 兼容 Prettier
+  // @see https://github.com/DavidAnson/markdownlint/blob/main/doc/Prettier.md
+  "blanks-around-fences": false,
+  "blanks-around-headings": false,
+  "blanks-around-lists": false,
+  "code-fence-style": false,
+  "emphasis-style": false,
+  "heading-start-left": false,
+  "hr-style": false,
+  "line-length": false,
+  "list-indent": false,
+  "list-marker-space": false,
+  "no-blanks-blockquote": false,
+  "no-hard-tabs": false,
+  "no-missing-space-atx": false,
+  "no-missing-space-closed-atx": false,
+  "no-multiple-blanks": false,
+  "no-multiple-space-atx": false,
+  "no-multiple-space-blockquote": false,
+  "no-multiple-space-closed-atx": false,
+  "no-trailing-spaces": false,
+  "ol-prefix": false,
+  "strong-style": false,
+  "ul-indent": false,
+
+  // 其他规则配置
+  // @see https://github.com/vuepress-theme-hope/vuepress-theme-hope/blob/main/.markdownlint.json
+  "default": true,
+  "MD003": {
+    "style": "atx"
+  },
+  "MD004": {
+    "style": "dash"
+  },
+  "MD013": false,
+  "MD024": {
+    "allow_different_nesting": true
+  },
+  "MD025": {
+    "front_matter_title": ""
+  },
+  "MD033": {
+    "allowed_elements": [
+      "br",
+      "template",
+      "script",
+      "style",
+      "ArtPlayer",
+      "AudioPlayer",
+      "AutoCatalog",
+      "Badge",
+      "BiliBili",
+      "Catalog",
+      "CodePen",
+      "DemoProject",
+      "FontIcon",
+      "ProjectLink",
+      "PDF",
+      "Replit",
+      "Share",
+      "SiteInfo",
+      "StackBlitz",
+      "XiGua",
+      "VideoPlayer",
+      "YouTube",
+      "AppearanceSwitch",
+      "HopeIcon",
+      "FlowChartPlayground",
+      "IconDisplay",
+      "KatexPlayground",
+      "NetlifyBadge",
+      "PrintButton",
+      "ThemeColorPicker",
+      "ToggleFullScreenButton",
+      "ToggleRTLButton"
+    ]
+  },
+  // 兼容 Prettier 禁用
+  // "MD035": {
+  //   "style": "---"
+  // },
+  "MD036": false,
+  "MD040": false,
+  "MD046": false,
+  "MD049": false
+}

.markdownlint.jsonc

@@ -0,0 +1,21 @@
+# Vuepress Cache
+**/.vuepress/.cache/**
+# Vuepress Temp
+**/.vuepress/.temp/**
+# Vuepress Output
+**/.vuepress/dist/**
+# Lib files
+**/.vuepress/public/assets/
+
+# Node modules
+node_modules/
+
+# Obsidian files
+**/.obsidian/**
+
+# NPM lock file
+pnpm-lock.yaml
+package-lock.json
+yarn.lock
+
+.husky/

.prettierignore

@@ -1,5 +1,6 @@
 {
   "recommendations": [
+    "esbenp.prettier-vscode",
     "davidanson.vscode-markdownlint",
     "yzhang.markdown-all-in-one"
   ]

.vscode/extensions.json

@@ -1,19 +1,28 @@
 {
+  /** 编辑器相关 **/
+  "editor.formatOnSave": true,
+  "editor.formatOnType": false,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {
+    "source.fixAll.markdownlint": "always",
+    "source.fixAll": "always"
+  },
   "[markdown]": {
     "editor.fontFamily": "Sarasa Mono SC, Noto Sans Mono CJK SC, monospace",
-    "editor.formatOnType": false,
-    "editor.formatOnSave": true,
-    "editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
+
+  /** Markdown 相关 **/
   "markdown.validate.enabled": true,
   "markdown.validate.fileLinks.enabled": "error",
+  "markdown.validate.referenceLinks.enabled": "ignore",
   "markdown.copyFiles.destination": {
     "**/*": "${documentWorkspaceFolder}/src/assets/"
   },
   "markdown.updateLinksOnFileMove.enabled": "always",
-  "editor.codeActionsOnSave": {
-    "source.fixAll.markdownlint": true
-  },
+  "markdown.editor.pasteUrlAsFormattedLink.enabled": "smart",
+
+  /** 文件管理器相关  **/
   // "explorer.sortOrder": "mixed",
   "explorer.excludeGitIgnore": false,
   "files.exclude": {
@@ -23,19 +32,18 @@
     "**/CVS": true,
     "**/.DS_Store": true,
     "**/Thumbs.db": true
-    // custom begin
+
+    /** custom begin **/
     // "node_modules": true,
+    // "package.json": true,
+    // "package-lock.json": true,
+    // "pnpm-lock.yaml": true
     // "**/.*": true,
     // ".github": true,
     // ".gitignore": true,
-    // "**/.vuepress": true,
     // ".vscode": true,
     // ".markdownlint.json": true,
-    // // "package.json": true,
-    // "package-lock.json": true,
-    // "CODE_OF_CONDUCT.md": true,
+    // "**/.vuepress": true,
     // "LICENSE": true
-  },
-  "markdown.editor.pasteUrlAsFormattedLink.enabled": "smart",
-  "markdown.validate.referenceLinks.enabled": "ignore"
+  }
 }

.vscode/settings.json

@@ -6,22 +6,28 @@
   "type": "module",
   "packageManager": "pnpm@8.11.0",
   "scripts": {
-    "docs:build": "vuepress build src",
-    "docs:clean-dev": "vuepress dev src --clean-cache",
     "docs:dev": "vuepress dev src",
+    "docs:clean-dev": "vuepress dev src --clean-cache",
     "docs:dev-debug": "vuepress dev src --debug",
-    "docs:update-package": "npx vp-update",
+    "docs:build": "vuepress build src",
+    "lint:prettier": "prettier --write .",
     "lint:md": "markdownlint-cli2-fix src/**/*.md",
-    "lint-md": "lint-md src/**/*.md --fix"
+    "docs:update-package": "npx vp-update",
+    "prepare": "husky install"
   },
   "devDependencies": {
-    "@lint-md/cli": "^2.0.0",
     "@vuepress/client": "2.0.0-rc.0",
+    "husky": "^8.0.0",
+    "lint-staged": "^15.1.0",
     "markdownlint-cli2": "^0.10.0",
     "mermaid": "^10.6.1",
+    "prettier": "2.8.8",
     "vue": "^3.3.9",
     "vuepress": "2.0.0-rc.0",
     "vuepress-plugin-search-pro": "2.0.0-rc.0",
     "vuepress-theme-hope": "2.0.0-rc.0"
+  },
+  "lint-staged": {
+    "*.md": "prettier --write"
   }
 }