mirror of
https://github.com/MCCTeam/Minecraft-Console-Client
synced 2025-10-14 21:22:49 +00:00
Update doc
This commit is contained in:
parent
2e7c024f45
commit
5a540f646c
10 changed files with 249 additions and 94 deletions
|
|
@ -6,28 +6,29 @@ A documentation website for Minecraft Console Client (MCC) written using [Vue Pr
|
|||
|
||||
### Requirements:
|
||||
|
||||
- Git
|
||||
- Node JS >= v12
|
||||
- Yarn
|
||||
|
||||
### Install Yarn if you don't have it:
|
||||
|
||||
```
|
||||
```bash
|
||||
npm i yarn -g
|
||||
```
|
||||
|
||||
Fork and clone the repository.
|
||||
Fork and clone the repository `Minecraft-Console-Client`.
|
||||
|
||||
All of the source is in the `source` directory.
|
||||
All of the source is in the `docs` directory.
|
||||
|
||||
### Install dependencies:
|
||||
|
||||
```
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
### Run developer mode:
|
||||
|
||||
```
|
||||
```bash
|
||||
yarn docs:dev
|
||||
```
|
||||
|
||||
|
|
@ -35,18 +36,4 @@ _If you have the port `8080` taken, use the `--port <port>` for a custom port._
|
|||
|
||||
Change things
|
||||
|
||||
### Build:
|
||||
|
||||
```
|
||||
yarn docs:build
|
||||
```
|
||||
|
||||
### Deploy changes:
|
||||
|
||||
```
|
||||
yarn docs:deploy
|
||||
```
|
||||
|
||||
**⚠️ Do not forget this step, or your changes will not go live!**
|
||||
|
||||
Commit, push and open a pull request.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue