README-zh.md

Document

English · Português do Brasil

此处托管着 GD 的文档。

Icon here is clickable.

简介

GriefDefender 的文档使用 VuePress 和 Theme Hope.

贡献

• 进行小规模更改
  每页底部会有跳转的链接来引导你到该仓库的文件，根据需求做出修改并提交 PR，Netlify 的机器人会自动生成预览。

• 搭建开发环境(适用于大面积更改)

1. 安装 NodeJS(>=16) 及 pnpm
2. 在本仓库根目录下运行命令 pnpm install 安装依赖。
3. 依赖安装成功后运行 pnpm docs:dev 并稍作等待
4. 待命令行出现 http://localhost:8080/ 字样访问该链接以查看文档。
5. 现在当你对文档做出更改时，网页端会进行实时同步！