Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 918 Bytes

README.md

File metadata and controls

35 lines (22 loc) · 918 Bytes

StarCraft II Editor Guides

This repository is hosting the tutorials originally hosted by Blizzard Entertainment for the Starcraft 2 Editor.

Now maintained and improved by the SC2Mapster community.

Deployment

https://s2editor-guides.readthedocs.io/

Local development

  • Install Poetry
  • poetry install
  • poetry shell

Site generator

We're using mkdocs.org.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs help - Print this help message.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.