Grasscutter Documention | 割草机文档

This website is built using Docusaurus 2, a modern static website generator.

此网页使用Docusaurus 2创建，这是一个现代化网页生成器

English Version comming soon！

英文版本很快就好

Installation

安装

$ yarn

push前请看

See before you push

若您想为我们的项目作出贡献，建议您push后在提交pr之前先在actions中查看测试是否通过(如果你在文档里添加了格式化代码或更改了代码文件)，若有需要，请在actions中手动构建查看文档是否达到自己的预期，别像我一样狼狈地删pr

If you want to contribute to our project, we recommend that you to see if the test is passed in actions before starting pr(If you have added formatting codes or changed the code file in the document), if necessary, please build manually in actions to see if the documentation meets your expectations, do not delete pr in a difficult position like I did

Local Development

本地开发

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

此命令会启动一个本地开发服务器并打开浏览器窗口，大部分改变会自动生效，无需重启服务器。

Build

构建

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

此命令将会在build文件夹中生成静态文件以让您将其部署到任何静态网页托管服务器中

Deployment

部署

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.