# guides

**Repository Path**: mirrors_pixijs/guides

## Basic Information

- **Project Name**: guides
- **Description**: PixiJS User Guides
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-10
- **Last Updated**: 2026-06-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

> **Warning**
> This repository is no longer maintained. Guides has been moved into the [main website's repository](https://github.com/pixijs/pixijs.com/tree/main/docs/guides) and is deployed to [pixijs.com/guides](https://pixijs.com/guides).

# PixiJS Guides

The purpose of this project is to provide high-level, authoritative guides about using [PixiJS](https://github.com/pixijs/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](https://pixijs.io/docs).

## Building

To build the documentation locally, install all dependencies:

```shell
npm install
```

Then simply run the `build` script to generate the guides.

```shell
npm run build
```

## Development

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

```shell
npm start
```