UNPKG

@ukegeeks/song-formatter

Version:

Convert ChordPro markup text to HTML with chord fingering diagrams

github.com/buzcarter/song-formatter

buzcarter/song-formatter

61 lines (38 loc) • 3.17 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# UkeGeeks Song Formatter [![Publish Demo Site](https://github.com/buzcarter/song-formatter/actions/workflows/publishDemo.yml/badge.svg)](https://github.com/buzcarter/song-formatter/actions/workflows/publishDemo.yml) Convert ChordPro marked-up text to HTML, complete with chord fingering diagrams. **Important:** *This is early stages of updating the UkeGeek's Scriptasaurus Song Editor, as such, this is an alpha test release: the final API is likely to change greatly.* ##### Status Update > *Currently converting dozens of manual tests to automated tests and adding support for other stringed instrument support (yup, finally guitars, not just ukuleles). On track to have full 1.0 release October 2023.* ##### Songsheets Perfect For Clubs ![Typical Layout](docs/images/ukulele-music-editor-grass-shack-sample.png) ## Installation With Node Package Manager (npm) ``` npm install @ukegeeks/song-formatter ``` ## Features | **Fingering Diagrams** | **Mini-Diagrams** | |-----------------------------------------------------------------------------|----------------------------------------------------------------------------| | ![Chord Fingering Diagrams](docs/images/chord-diagrams.png) | ![Mini-Diagrams Above Lyrics](docs/images/chords-above-lyrics.png) | | Easy to read chord diagrams with over 180 optimized fingerings pre-defined. | Mix mini-chord fingering diagrams above lyrics for quick reading. | | **Tablature** | **Easy Markup** | |-----------------------------------------------------------------------------|----------------------------------------------------------------------------| | ![Tablature](docs/images/tablature.png) | ![Easy Markup using ChordPro Syntax](docs/images/cpm-song-text.png) | | Easy on the eyes tabs for solo uke. | Leverages intuitive ChordPro Markup, converts plain text on-the-fly. | | **Define Your Own Chords** | **Print Power** | |-----------------------------------------------------------------------------|----------------------------------------------------------------------------| | ![Define your own custom chords](docs/images/custom-chords.png) | ![Control how your songs print](docs/images/song-chord-diagrams-above.png) | | Include alternative voicings, power-chords, or any chord shape you like. | Control how your songs print with multiple columns. | * Add your own custom chords and fingerings * Specify diagram colors & sizes * Choose whether to include diagrams to the side or above the lyrics * Multiple songs per page * Transposing ### Mix Tablature, Lyrics, & Fingering Diagrams ![Typical Layout](docs/images/ukulele-tablature-editor-example.png) ## Usage ... ## Demo/Test ##### Coming Soon