Warning This repository is no longer maintained. Guides has been moved into the main website's repository and is deployed to pixijs.com/guides.

PixiJS Guides

The purpose of this project is to provide high-level, authoritative guides about using PixiJS. The concepts in these guides are generalized and shouldn't change much from version to version of PixiJS. If you're looking specific code documentation, view our API docs.

Building

To build the documentation locally, install all dependencies:

npm install

Then simply run the build script to generate the guides.

npm run build

Development

To develop the guides in a browser, run the following command. Changes to the souce documentation will automatically re-build.

npm start