perf: 优化排版和 .gitignore 文件 feat: 增加 Markdown 检查功能

.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: "setup pnpm"
+        uses: "pnpm/action-setup@v4"
+
+      - name: "setup node"
+        uses: "actions/setup-node@v4"
+        with:
+          node-version: 20
+
+      - name: "Install"
+        run: "pnpm install"
+
+      - name: "MarkdownLint 检查"
+        uses: DavidAnson/markdownlint-cli2-action@v20
+        with:
+          fix: true
+          globs: 'docs*/**/*.md'
+
+      - name: "构建 测试"
+        run: "pnpm run build"

.gitignore

@@ -1,2 +1,11 @@
-node_modules
-.docusaurus
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+
+# IDE
+.idea

.markdownlint.jsonc

@@ -0,0 +1,8 @@
+{
+  "default": true,
+  "line-length": {"line_length": 150},
+  "single-h1": false,
+  "no-bare-urls": false,
+  "no-inline-html": false,
+  "no-alt-text": false
+}

docs/intro.md

@@ -9,17 +9,17 @@ Hi~ 👋 欢迎来到 BukuWiki~
 
 **BukuWiki** 是为Minecraft玩家提供完整的终极指南，你可以在这里找到所有的 **疑问和帮助**。
 
-但是你也不能**啥都不会**，你至少要会这些：
+但是你也不能  **啥都不会**，你至少要会这些：
 
-- 有一台不要**太过时**的设备/手机
-- 会**最基本的 **PC / 手机操作，解压、下载之类的
-- 具有一定英语基础或**可以学习**的想法
+- 有一台不要 **太过时** 的设备/手机
+- 会 **最基本的** PC / 手机操作，解压、下载之类的
+- 具有一定英语基础或 **可以学习** 的想法
 
 ## 这个 Wiki 有什么用？
 
-**BukuWiki** 的初衷是为了玩家可以为一些各种各样的问题，却在**搜索引擎找不到好的解决办法或者是难的问题**，提供解决办法和应对措施。
+**BukuWiki** 的初衷是为了玩家可以为一些各种各样的问题，却在 **搜索引擎找不到好的解决办法或者是难的问题**，提供解决办法和应对措施。
 
-说明白点就是一份游玩 Minecraft 的**百科全书**，包括你游玩过程中断所有内容。
+说明白点就是一份游玩 Minecraft 的 **百科全书**，包括你游玩过程中断所有内容。
 
 **BukuWiki** 实现这一点还需要很久，所以慢慢来，不要着急。
 
@@ -31,7 +31,7 @@ Hi~ 👋 欢迎来到 BukuWiki~
 
 - **无厘头**，一心急着求成，**静不下心的**
 - **不会好好看文章的**
-- 动手能力**极差的**
+- 动手能力 **极差的**
 
 ## 准备好了？那就开始你在 BukuWiki 的旅途吧~
 

docs/write-specifications.md

@@ -7,11 +7,11 @@ sidebar_position: 3
 
 如果你愿意为 BukuWiki 提供新的内容，请务必认真查看下面的编写规范，我们在审核 PR 的时候会按照规范，严重不符将会被拒，谢谢配合。
 
-1. BukuWiki 不欢迎**通篇**的 AI 内容，可以在片段使用AI简单编写，至少不能让整个文档都充斥着 AI 文。
+1. BukuWiki 不欢迎 **通篇** 的 AI 内容，可以在片段使用AI简单编写，至少不能让整个文档都充斥着 AI 文。
 
-2. 建议在**中英文和数字之间**插入空格，这样能让文档阅读更舒服一点。我们已经在前端加入了 `pangu` 进行纠正，但我们希望各位创作者要在适宜处插入空格，以便于阅读。
+2. 建议在 **中英文和数字之间** 插入空格，这样能让文档阅读更舒服一点。我们已经在前端加入了 `pangu` 进行纠正，但我们希望各位创作者要在适宜处插入空格，以便于阅读。
 
-3. 但是最好不要在**中文和中文之间**插入空格，如 "张三今天 导了 一发"，这样只会让阅读体验下降。如果是**专用名词或特别强调处**则可以加入空格以便区分，例如：我们则需要用到 **联机模块**
+3. 但是最好不要在 **中文和中文之间** 插入空格，如 "张三今天 发了 一个维 基"，这样只会让阅读体验下降。如果是 **专用名词或特别强调处** 则可以加入空格以便区分，例如：我们则需要用到 **联机模块**
 
 4. 如果你需要新建目录或新的章节，请务必按照已有的风格创建，简单明了，便于其他创作者阅读或编辑。
 
@@ -21,8 +21,10 @@ sidebar_position: 3
 
 7. 善用 Markdown 语法，重要内容可以加粗处理，引用内容要使用引用语法，对于一些无关紧要的说明，或者只是一些吐槽，可以用倾斜语法。
 
+如果你需要更改或新增文档内容，我们已经为你们准备好了 MarkDown 检查工具，请务必在提交之前检查你的文档书写。直接运行 `format:check` 就能检查你的书写，他会告诉你有哪些部分未按照标准书写，你可以选择手动修复它们，也可以选择运行 `format` 尝试自动修复。
 
 请注意，你的每次 PR 都要对你自己负责，所以在提交新的内容之前，请务必本地构建测试，认真检查类似于错别字的内容之后，再提交 PR 。不管是低质量的内容，还是不符合规范的内容，请你仔细斟酌。
 
 最后，感谢所有为 BukuWiki 的贡献者，是你们一起完成了这份有意义的 Wiki ，谢谢你们！
 
+[//]: # (推荐阅读：[基于 Markdown 的中文文档排版规范](https://zhuanlan.zhihu.com/p/144446995))

package.json

@@ -11,7 +11,9 @@
     "clear": "docusaurus clear",
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
-    "write-heading-ids": "docusaurus write-heading-ids"
+    "write-heading-ids": "docusaurus write-heading-ids",
+    "format": "markdownlint-cli2 --fix --glob 'docs*/**/*.md'",
+    "format:check": "markdownlint-cli2 --glob 'docs*/**/*.md'"
   },
   "dependencies": {
     "@docusaurus/core": "3.8.0",
@@ -27,7 +29,8 @@
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "3.8.0",
-    "@docusaurus/types": "3.8.0"
+    "@docusaurus/types": "3.8.0",
+    "markdownlint-cli2": "0.18.0"
   },
   "browserslist": {
     "production": [