Clone this wiki locally
The VexFlow Wiki
- The VexFlow Tutorial - Get started by learning the basics of the classic and powerful VexFlow rendering API.
- If your needs are less complex, check out Using EasyScore to learn about the simpler EasyScore API.
- Almost every VexFlow project begins with the same five lines of code. Check out Understanding Renderer and Context to learn what they really do.
- API Documentation generated from the source code. This is a work in progress.
- The VexFlow FAQ - Frequently Answered Questions from the VexFlow mailing list.
- VexFlow Sandbox - A place to experiment with the VexFlow API.
- Build Instructions - How to build VexFlow from scratch. Requires Ruby and NodeJS.
- VexFlow Forum Archive - Feel free to join and ask questions on the forum.
- VexFlow Class Hierarchy and Dependency Graph
- Visual Regression Tests
- Animating VexFlow with CSS
Join the VexFlow Google Group at: https://groups.google.com/forum/?fromgroups#!forum/vexflow
See the coding style guide guide for general rules and conventions.
Send in your changes via a GitHub pull request.
Take a look at the Development Gotchas if some aspects of VexFlow's internals seem confusing.
Please include tests -- I will not commit changes that don't have accompanying tests.
Don't forget to run the Visual Regression Tests -- it is simpler, faster, and more likely to catch issues than eyeballing the output of the QUnit tests.
If you add a new feature, update this Wiki with some documentation and examples.
- Mohit Muthanna Cheppudira
- Cyril Silverman
- Larry Kuhns
- Gregory Ristow
- Michael Scott Cuthbert
- Aaron Mars
- Taehoon Moon
All past contributors: https://github.com/0xfe/vexflow/graphs/contributors