Home

Learn

VexFlow Tutorial - Get started by learning the basics of the classic and powerful VexFlow rendering API.
If your needs are less complex, check out 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.
Frequently Answered Questions from the VexFlow mailing list.
VexFlow Sandbox - A place to experiment with the VexFlow API.
VexFlow Forum Archive - Feel free to join and ask questions on the forum.
VexFlow Class and Dependency Graphs.
Animating VexFlow with CSS

Build and Release Instructions - How to build VexFlow from scratch. Use grunt watch to watch files. How to release packages.
Font Rendering - How to add new glyphs and fonts to VexFlow.
Visual Regression Tests - How to run the visual regression tests.

Join the VexFlow Google Group at: https://groups.google.com/g/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.
Test Your Code. Please include tests. Changes that don't have accompanying tests will not be merged.
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.