Skip to content

Commit

Permalink
Merge pull request pixi-viewport#412 from cuire/update-docs
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
davidfig authored Jan 8, 2023
2 parents 1d65518 + e13e409 commit 0dd21e8
Show file tree
Hide file tree
Showing 225 changed files with 318 additions and 264,473 deletions.
2 changes: 1 addition & 1 deletion .jsdoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"recurse": true,
"private": false,
"lenient": true,
"destination": "./docs/jsdoc",
"destination": "./docs/dist/jsdoc",
"template": "./node_modules/yy-jsdoc-template"
},
"plugins": [
Expand Down
14 changes: 1 addition & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,18 +78,6 @@ or [grab the latest release](https://github.com/davidfig/pixi-viewport/releases/
</script>
```

## Build Examples
I've included the following build examples in the docs/ directory:

* [flems-io interactive demo](https://davidfig.github.io/pixi-viewport/)
* [original demo built with rollup](https://github.com/davidfig/pixi-viewport/tree/master/docs/original)
* [browserify](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/browserify)
* [rollup](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/rollup)
* [standalone (e.g., cdn)](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/standalone)
* [typescript](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/ts).

You can see the live demos at [https://davidfig.github.io/pixi-viewport/builds/](https://davidfig.github.io/pixi-viewport/builds/).

## Migration from pixi-viewport v3 to v4
Viewport needs to be imported or required as follows:
```js
Expand Down Expand Up @@ -126,7 +114,7 @@ viewport.plugins.add('name', plugin, index)
1. clone repository
2. yarn install
3. yarn dev
4. open browser to http://localhost:10001
4. open browser to http://localhost:5173

PRs are more than welcome!

Expand Down
Binary file removed docs/.DS_Store
Binary file not shown.
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/dist
137 changes: 0 additions & 137 deletions docs/animate/index.html

This file was deleted.

30 changes: 0 additions & 30 deletions docs/builds/browserify/code.js

This file was deleted.

10 changes: 0 additions & 10 deletions docs/builds/browserify/index.html

This file was deleted.

Loading

0 comments on commit 0dd21e8

Please sign in to comment.