docs(next): 更新贡献指南和项目README

Author: hello8693

README.md

@@ -1,37 +1,31 @@
 # ClassIsland 文档
 
-这是 [ClassIsland](https://github.com/HelloWRC/ClassIsland) 文档仓库。本文档基于 [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) 搭建，目前托管在 [Read The Docs](https://app.readthedocs.org/projects/classisland-docs/) 上。
+这是 [ClassIsland](https://github.com/HelloWRC/ClassIsland) 文档仓库。本文档基于 [VuePress](https://vuejs.press/) 搭建
 
-[在线查看文档](https://docs.classisland.tech/)
+[在线查看文档](https://classisland.github.io/classisland-docs-next/)
 
 ## 开始编写文档
 
-1. 安装 [Python 3](https://www.python.org/downloads/) 环境
+1. 安装 Node 20 环境（推荐使用NVM）
 2. 克隆并进入文档仓库
-3. 设置虚拟环境 **（建议）**
+3. 安装依赖（需要使用pnpm，可使用corepack安装）
+   ```sh
+   pnpm install
+   ```
 
-    ``` bash
-    python -m venv ./venv
-    ./venv/scripts/activate
-    ```
-
-4. 安装依赖
-
-    ``` bash
-    python -m pip install -r requirements.txt
-    ```
-
-5. 启动 MkDocs 服务器
+4. 启动 VuePress 服务器
 
     ``` bash
-    mkdocs serve
+    pnpm run docs:dev
     ```
 
-启动 MkDocs 服务器后，在浏览器中打开终端输出的链接（默认是[http://localhost:8000/](http://localhost:8000/)）即可浏览文档。当本地文档做出更改时，浏览器中的文档将自动刷新。
+启动 VuePress 服务器后，在浏览器中打开终端输出的链接（默认是[http://localhost:8080/classisland-docs-next/](http://localhost:8080/classisland-docs-next/)）即可浏览文档。当本地文档做出更改时，浏览器中的文档将自动刷新。
 
-本文档使用了 MkDocs 的一些扩展语法，请尽量直接编辑 Markdown 文件，而不是使用可视化 Markdown 编辑器。建议使用 [Visual Studio Code](https://code.visualstudio.com/) 编辑文档。
+本文档使用了 vuepress-plugin-md-enhance
+ 的一些扩展语法，请尽量直接编辑 Markdown 文件，而不是使用可视化 Markdown 编辑器。建议使用 [Visual Studio Code](https://code.visualstudio.com/) 编辑文档。
 
-关于 MkDocs 和 Material For MkDocs 的用法，请参见 [MkDocs 文档](https://www.mkdocs.org/getting-started/) 和 [Material For MkDocs 文档](https://squidfunk.github.io/mkdocs-material/)。
+关于 VuePress 和 vuepress-plugin-md-enhance
+ 的用法，请参见 [VuePress 文档](https://vuejs.press/) 和 [vuepress-plugin-md-enhance 文档](https://plugin-md-enhance.vuejs.press/zh/)。
 
 ## 做出贡献
 
@@ -41,8 +35,8 @@
 
 感谢以下为本文档做出贡献的同学：
 
-<a href="https://github.com/ClassIsland/classisland-docs/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=ClassIsland/classisland-docs&max=1000" alt="贡献者名单"/>
+<a href="https://github.com/ClassIsland/classisland-docs-next/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ClassIsland/classisland-docs-next&max=1000" alt="贡献者名单"/>
 </a>
 
 ## 许可证

src/community/contributing.md

@@ -0,0 +1,57 @@
+# 向 ClassIsland 文档做贡献
+
+::: warning 注意
+本文章是面向 _**ClassIsland 文档**_ 贡献者的贡献指南。如果您要为 **ClassIsland 本体** 做出贡献，请参阅 [ClassIsland 贡献指南](https://github.com/ClassIsland/ClassIsland/blob/master/CONTRIBUTING.md)。
+:::
+
+<img src="/image/contributing/Firefly_Sticker_01.png"
+    width="85"
+    alt="流萤 - 比心"/>
+
+本文档的建设离不开广大用户的支持，感谢您考虑为本文档做出贡献❤️！在为本文档贡献之前，请先阅读本指南。
+
+本文档基于 [VuePress](https://vuepress.vuejs.org/) 搭建。了解 [VuePress](https://vuepress.vuejs.org/) 的用法对编写本文档很有帮助。
+
+本文档目前托管在 [GitHub Pages](https://pages.github.com/) 上。
+
+## 贡献准则
+
+- 使用小写文件名
+
+    VuePress 对 URL 链接大小写敏感，使用包含大写字母的文件名可能会出现一些问题。在命名文档和文件夹时请使用小写字母，并用`-`分割每个单词，例如：
+
+    ``` plaintext
+    example-doc.md
+    example-folder/
+        |- another-doc.md
+    ```
+
+- 将图片放置在仓库文件中
+
+    插入图片时请尽量直接将源文件插入到仓库文件中，不使用额外的 CDN / 图床承载图片，以便发布文档时自动将图片等文件打包到 GitHub Pages 上。插入的图片请放置在 `(文档目录)/image/(文档文件名)`下，例如：
+
+    ``` plaintext
+    example-doc.md
+    example-doc-2.md
+    image/
+        |- example-doc/
+        |   |- image1.png
+        |   |- image2.png
+        |- example-doc-2/
+            |- image1.png
+            |- image2.png
+    ```
+
+- 编写简单易读的文档
+
+    在编写文档时请尽量做到简单易读。必要时可以插入图片、Mermaid 图表等便于读者理解。
+
+## 合并更改
+
+您可以向本项目发起 [Pull Request](https://github.com/ClassIsland/classisland-docs-next/pulls) 来合并您的更改。在发起 Pull Request 时，请简要地描述您做的更改。
+
+更改合并以后，您可以在 [最新版文档](https://classisland.github.io/classisland-docs-next/) 中看到您的更改。
+
+## 还有疑问？
+
+您可以[加入 QQ 群](https://qm.qq.com/q/4NsDQKiAuQ)与开发者和其他用户讨论。