Merge pull request #93 from tiddly-gittly/autocorrect

规范化太微中文教程文档

.autocorrectignore

@@ -0,0 +1,6 @@
+tiddlers/TCTSystem/
+**/*.json
+**/*.js
+**/*.meta
+**/*.yml
+**/*.yaml

.autocorrectrc

@@ -0,0 +1,37 @@
+# yaml-language-server: $schema=https://huacnlee.github.io/autocorrect/schema.json
+# Config rules
+rules:
+  # Auto add spacing between CJK (Chinese, Japanese, Korean) and English words.
+  # 0 - off, 1 - error, 2 - warning
+  space-word: 1
+  # Add space between some punctuations.
+  space-punctuation: 1
+  # Add space between brackets (), [] when near the CJK.
+  space-bracket: 1
+  # Add space between ``, when near the CJK.
+  space-backticks: 1
+  # Add space between dash `-`
+  space-dash: 0
+  # Convert to fullwidth.
+  fullwidth: 1
+  # To remove space near the fullwidth.
+  no-space-fullwidth: 1
+  # Fullwidth alphanumeric characters to halfwidth.
+  halfwidth-word: 1
+  # Fullwidth punctuations to halfwidth in english.
+  halfwidth-punctuation: 1
+  # Spellcheck
+  spellcheck: 2
+# textRules:
+fileTypes:
+  '.tid': 'markdown'
+spellcheck:
+  # Correct Words (Case insensitive) for by Spellcheck
+  words:
+    - GitHub
+    - App Store
+    # This means "appstore" into "App Store"
+    - AppStore = App Store
+    - Git
+    - Node.js
+    - nodejs = Node.js

.gitignore

@@ -22,4 +22,4 @@ $__config_Navigation_openLinkFromOutsideRiver.tid
 tiddlers/$__UpgradeLibrary.json
 tiddlers/$__UpgradeLibrary.json.meta
 tiddlers/$__plugins_linonetwo_commandpalette_CommandPaletteHistory.json
-tiddlers/$__plugins_linonetwo_commandpalette_CommandPaletteHistory.json.meta
+tiddlers/$__plugins_linonetwo_commandpalette_CommandPaletteHistory.json.meta

README.md

@@ -4,7 +4,7 @@
 
 [只读版访问地址 Netlify 加速版（国内中速访问）](https://tw-cn.netlify.app)
 
-[只读版访问地址机器人共用版（国内中速访问）](https://tw-cn.cpolar.top/) （QQ群内直接打「cn 搜索词」时，机器人就是使用它提取知识）
+[只读版访问地址机器人共用版（国内中速访问）](https://tw-cn.cpolar.top/) （QQ 群内直接打「cn 搜索词」时，机器人就是使用它提取知识）
 
 [只读版访问地址（翻墙 Github Pages）](https://tiddly-gittly.github.io/TiddlyWiki-Chinese-Tutorial/)
 
@@ -19,7 +19,7 @@
 
 ### 简单版
 
-0. 找QQ群主联系提供加入贡献团队。
+0. 找 QQ 群主联系提供加入贡献团队。
 1. 下载 [TidGi-Desktop](https://github.com/tiddly-gittly/TidGi-Desktop)，用于在本地打开和编辑 Wiki
 
 ![docs/image/clone-code-tg.png](https://cdn.jsdelivr.net/gh/tiddly-gittly/TiddlyWiki-Chinese-Tutorial/docs/image/clone-code-tg.png)
@@ -31,7 +31,7 @@
 
 然后就能编辑了，编辑结果会每 30 分钟自动同步上来，或是在重启应用后自动同步上来。也可以右键点击左侧边栏的工作区头像，有一个立即同步选项。
 
-![截屏2022-09-27 18 36 44](https://user-images.githubusercontent.com/3746270/192504211-8b11d325-343e-4d50-9be0-bde5987e6f76.png)
+![截屏 2022-09-27 18 36 44](https://user-images.githubusercontent.com/3746270/192504211-8b11d325-343e-4d50-9be0-bde5987e6f76.png)
 
 一段时间没修改后，如果要改，建议先点立即同步，把其他人的改动同步过来，以免发生冲突了麻烦。
 

package.json

@@ -3,13 +3,21 @@
     "server": "npx cross-env TIDDLYWIKI_PLUGIN_PATH='./plugins' TIDDLYWIKI_THEME_PATH='./themes' TIDDLYWIKI_LANGUAGE_PATH='./languages' npx tiddlywiki . --listen port=8080",
     "buildonline": "node -e \"require('./scripts/build').buildOnlineHTML('public-dist', 'index.html');\"",
     "buildoffline": "node -e \"require('./scripts/build').buildOfflineHTML('public-dist', 'offline.html');\"",
-    "buildlibrary": "node -e \"require('./scripts/build').buildLibrary('[prefix[$:/]!prefix[$:/plugins/tiddlywiki/]!prefix[$:/themes/tiddlywiki/]!prefix[$:/languages/]!tag[$:/tags/PluginLibrary]!prefix[$:/plugins/kookma]]', 'public-dist/library');\""
+    "buildlibrary": "node -e \"require('./scripts/build').buildLibrary('[prefix[$:/]!prefix[$:/plugins/tiddlywiki/]!prefix[$:/themes/tiddlywiki/]!prefix[$:/languages/]!tag[$:/tags/PluginLibrary]!prefix[$:/plugins/kookma]]', 'public-dist/library');\"",
+    "dev": "tiddlywiki --listen",
+    "format": "autocorrect --fix",
+    "prepare": "simple-git-hooks"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm autocorrect --fix"
   },
   "devDependencies": {
+    "autocorrect-node": "^2.9.0",
     "cross-env": "7.0.3",
     "html-minifier-terser": "7.2.0",
+    "simple-git-hooks": "^2.9.0",
     "tiddlywiki": "5.3.0",
     "uglify-js": "3.17.4",
     "workbox-cli": "7.0.0"
   }
-}
+}