/docs

This is the respository backing the official modding documentation for Voxel Tycoon — a tycoon strategy game about transportation, factories, and mining infinite voxel landscapes.

Primary LanguageDockerfile

Welcome!

This is the respository backing the official modding documentation for Voxel Tycoon — a tycoon strategy game about transportation, factories, and mining infinite voxel landscapes.

How to test your contribution locally

Install

  1. Install Material for MkDocs.
  2. Instal plugins:
  • pip install mkdocs-minify-plugin
  • pip install mkdocs-git-revision-date-localized-plugin
  • pip install mkdocs-awesome-pages-plugin

Run

  1. Run mkdocs serve.
  2. Go to http://localhost:8000.
  3. Pages will automatically refresh as you apply changes to sources.

Talk to community