2022-11-04 10:40:28 +08:00
|
|
|
# About
|
|
|
|
|
|
|
|
|
|
A documentation website for Minecraft Console Client (MCC) written using [Vue Press 2.0](https://v2.vuepress.vuejs.org/)
|
|
|
|
|
|
|
|
|
|
## How to contribute
|
|
|
|
|
|
|
|
|
|
### Requirements:
|
|
|
|
|
|
2022-11-07 11:15:19 +08:00
|
|
|
- Git
|
2022-11-04 10:40:28 +08:00
|
|
|
- Node JS >= v12
|
|
|
|
|
- Yarn
|
|
|
|
|
|
|
|
|
|
### Install Yarn if you don't have it:
|
|
|
|
|
|
2022-11-07 11:15:19 +08:00
|
|
|
```bash
|
2022-11-04 10:40:28 +08:00
|
|
|
npm i yarn -g
|
|
|
|
|
```
|
|
|
|
|
|
2022-11-07 11:15:19 +08:00
|
|
|
Fork and clone the repository `Minecraft-Console-Client`.
|
2022-11-04 10:40:28 +08:00
|
|
|
|
2022-11-07 11:15:19 +08:00
|
|
|
All of the source is in the `docs` directory.
|
2022-11-04 10:40:28 +08:00
|
|
|
|
|
|
|
|
### Install dependencies:
|
|
|
|
|
|
2022-11-07 11:15:19 +08:00
|
|
|
```bash
|
2022-11-04 10:40:28 +08:00
|
|
|
yarn install
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Run developer mode:
|
|
|
|
|
|
2022-11-07 11:15:19 +08:00
|
|
|
```bash
|
2022-11-04 10:40:28 +08:00
|
|
|
yarn docs:dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
_If you have the port `8080` taken, use the `--port <port>` for a custom port._
|
|
|
|
|
|
|
|
|
|
Change things
|
|
|
|
|
|
|
|
|
|
Commit, push and open a pull request.
|