starcraft2-api-docs

Doc site for StarCraft2-API deployed on starcraft2-api.lukem.net, built with VuePress.

Install and run locally

git clone https://github.com/blizzapi/starcraft2-api-docs.git
cd starcraft2-api-docs
npm install
npm run dev

When npm run dev is ran local instance of the doc site is available at http://localhost:8080.

Contributions

Contributions of any kind are welcome.

Minor corrections (e.g. typo fixes, better code samples) can be submitted as PRs via GitHub web interface.

Before contributing be sure to read StarCraft2-API Contributing Guidelines and Code of Conduct.

Contributors

Thank you for improving StarCraft2-API documentation!

We maintain an AUTHORS file where we keep a list of all project contributors. Please consider adding your name there with your next PR.

License

Licensed under MIT License. See LICENSE for more information.

Legal

This project is not authored, affiliated or endorsed in any way by Blizzard Entertainment.

Battle.net and Blizzard Entertainment are trademarks or registered trademarks of Blizzard Entertainment, Inc. in the U.S. and/or other countries.

© 2010 Blizzard Entertainment, Inc. All rights reserved. Wings of Liberty is a trademark, and StarCraft and Blizzard Entertainment are trademarks or registered trademarks of Blizzard Entertainment, Inc. in the U.S. and/or other countries.

© 2013 Blizzard Entertainment, Inc. All rights reserved. Heart of the Swarm and StarCraft are trademarks or registered trademarks of Blizzard Entertainment, Inc. in the U.S. and/or other countries.