No description
f24e2b96d5
I tried to generate the API section of the docs automatically from tsdoc comments. That failed for the follwing reasons: 1. It has been difficult to configure the layout of the API docs, such as, what information to show, how to sort the information, etc. I kept getting less relevant parts of the API show up before the more important parts. I would have had to write a plugin/theme for typedoc to fix that, which doesn't seem worth the effort. 2. The generated docs don't seem to be nearly as useful as the docs shown in the editor. It's just easier to browse the API in an IDE than on a static website. 3. Docs must have a narrative (we're trying to walk the user through the library) which goes against the unordered nature of automatically generated docs. |
||
|---|---|---|
| .github/workflows | ||
| .husky | ||
| .vscode | ||
| .yarn | ||
| devEnv | ||
| examples | ||
| packages | ||
| theatre | ||
| .editorconfig | ||
| .eslintrc.js | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| .yarnrc.yml | ||
| babel.config.js | ||
| CONTRIBUTING.md | ||
| jest.config.js | ||
| lerna.json | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.base.json | ||
| yarn.lock | ||
Theatre.js
Theatre.js is an animation library for high-fidelity motion graphics. It is designed to help you express detailed animation, enabling you to create intricate movement, and convey nuance.
Theatre can be used both programmatically and visually.
Theatre works with all rendering stacks. You can use it to animate DOM elements, THREE.js objects, or any kind of JavaScript variable.
Documentation and Tutorials
You can find the documentation and video tutorials here.
Community
Join us on Discord or write us an email.
License
Your use of Theatre.js is governed under the Apache License Version 2.0:
- Theatre's core (
@theatre/core) is released under the Apache License. Same goes for most packages in this repository. - The studio (
@theatre/studio) is released under the AGPL 3.0 License. This is the package that you use to edit your animations, setup your scenes, etc. You only use the studio during design/development. Your project's final bundle only includes@theatre/core, so only the Apache License applies.