mirror of
https://github.com/MCCTeam/Minecraft-Console-Client
synced 2025-10-14 21:22:49 +00:00
53 lines
731 B
Markdown
53 lines
731 B
Markdown
|
# About
|
||
|
|
|
||
|
|
A documentation website for Minecraft Console Client (MCC) written using [Vue Press 2.0](https://v2.vuepress.vuejs.org/)
|
||
|
|
|
||
|
|
## How to contribute
|
||
|
|
|
||
|
|
### Requirements:
|
||
|
|
|
||
|
|
- Node JS >= v12
|
||
|
|
- Yarn
|
||
|
|
|
||
|
|
### Install Yarn if you don't have it:
|
||
|
|
|
||
|
|
```
|
||
|
|
npm i yarn -g
|
||
|
|
```
|
||
|
|
|
||
|
|
Fork and clone the repository.
|
||
|
|
|
||
|
|
All of the source is in the `source` directory.
|
||
|
|
|
||
|
|
### Install dependencies:
|
||
|
|
|
||
|
|
```
|
||
|
|
yarn install
|
||
|
|
```
|
||
|
|
|
||
|
|
### Run developer mode:
|
||
|
|
|
||
|
|
```
|
||
|
|
yarn docs:dev
|
||
|
|
```
|
||
|
|
|
||
|
|
_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.
|