Home

Learn

• VexFlow Tutorial - Get started by learning the basics of the powerful VexFlow rendering API.
• If your needs are less complex, check out EasyScore to learn about the simpler EasyScore API.
• VexFlow projects usually start with the same few 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 Asked Questions from the VexFlow mailing list.
• Experiment with the VexFlow API sandbox.
• VexFlow Forum - Feel free to join and ask questions on the forum.
• VexFlow Class and Dependency Graphs.
• Animating VexFlow with CSS

Developer Instructions

• Overview of VexFlow 4
• Build, Test, and Release Instructions
• Font Rendering - How to add new glyphs and fonts to VexFlow.
• Guide to running the Visual Regression Tests.

Contribute

• Join the VexFlow Google Group: https://groups.google.com/g/vexflow
• See the coding style guide guide for 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 documentation and examples. Thanks!