Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.25 KB

README.md

File metadata and controls

27 lines (18 loc) · 1.25 KB
Raw

Wiki

Build Status Documentation Status
The small documentation of the MineYourMind modded Minecraft Server Community. Here on github so everyone can suggest changes and additions.

Local Environment

You can setup an environment so you can instantly see the changes that have been made to the docs.

  1. Install VS Code
  2. Install reStructuredText Extension
  3. Click "Open Preview to the Side" and choose sphinx for preview

Alternative

Install the following and view it in the browser:

  1. Install Python 3
  2. Install node.js
  3. Install yarn

Open the terminal or command line in the main directory of this project and run the following commands:

yarn install
pip install -r requirements.txt
yarn run gulp

Your browser will open a local site of the docs. When you make a change to the documentation it will refresh the site in your browser.