text-guitar-chart
v0.0.3
Published
A JavaScript library to write text based guitar chord charts and convert them to SVG.
Maintainers
Readme
Text Guitar Chart
This library allows to write fretboard charts in a text format that is easy to read. It also includes utilities to convert the charts in svg using svguitar.
See the format
How to use
Use the editor to edit the fingering you like. Copy paste the fretboard chart wherever you like!
Utilities
Here is a list of utilities it provides:
- EditableSVGuitarChord an editable chord chart utility
- stringToFingering transforms a text representation of a fingering into data that can be used to render that fingering using SVGuitar
- fingeringToString transforms SVGuitar data format into a text representation of a fingering
TypeScript Support
This library includes TypeScript declarations generated from JSDoc comments:
npm run build:typesDevelopment
Running Tests
npm test
npm run test:watch # Watch modeGenerate Type Declarations
npm run build:typesLicense
This project is licensed under the MIT License - see the LICENSE file for details.
