readme.md

Document

中文 · Português do Brasil

Here is the documentation of GD which is based on vuepress.

Icon here is clickable.

Table of Contents

• Introduction
• Contribution

Introduction

GriefDefenderDoc was built with VuePress and Theme Hope.

Contribution

• I just want to slightly change the document.
  In the bottom of each pages there will be a button redirect you to the source file of pages, then you can make a PR to WIKI.

• I really want to make a big change to documentation!

1. You should install NodeJS(>=16) and pnpm properly.
2. Run command pnpm install in the root of GriefDefenderDoc.
3. Run pnpm docs:dev then wait a moment
4. Explore your dev enviroment in http://localhost:8080/
5. Any changes to a Markdown file should be sync to your web.