Code Monkey home page Code Monkey logo

ace-chordpro-extension's Introduction

UkeGeeks Ace Editor ChordPro Language Extension

ChordPro song editing extension for the Ace Editor (version 1.27.0).

Try the Live Editor Demo (includes Help tips)

For a basic setup look at Live Minimal Editor

Important: This is early stages of updating the UkeGeek's Scriptasaurus Song Editor, as such, this is an alpha test release: the final installation & usage is likely to change greatly.

ukegeeks-AceEditor-ChordPro-extension-screenshot

Installation

Download the files and run locally:

git clone https://github.com/buzcarter/ace-chordpro-extension.git

Download the project Zipped from GitHub

Use within another app:

npm install @ukegeeks/ace-chordpro-extension

Demo

Load "editor.html" (includes help sidebar) in your browser.

Currently the define & tab statements auto-complete snippet defaults to four strings (for ukulele fans out there)

Usage

Load "basic.html" (a barebones usage) in your browser.

<pre id="songEditor" class="my-editor">
{title: The Tao of Lasso}

Boy, I [A7]love meeting [D7]people’s moms.
It’s like [B7]reading an [E7]instruction manual 
as to why they’re [G] nuts.
</pre>
<script src="{path to your installation}/dist/ace-chordpro.min.js"></script>
const EDITOR_ID = 'my-editor';

// Let Ace know where it should inject itself on the page,
// it will grab the contents within this elemtn (`<pre/>`)
const editor = window.ace.edit(EDITOR_ID);

// choose a color scheme (see Ace prebuilts for dozens of choices)
editor.setTheme('ace/theme/idle_fingers');

// Now we tell Ace to treat our text as ChordPro
editor.session.setMode('ace/mode/chordpro');
editor.setOptions({
    enableBasicAutocompletion: true,
    enableSnippets: true,
});

License

This library is licensed under GNU General Public License.

Use it, change it, fork it, but please leave the author attribution.

ace-chordpro-extension's People

Contributors

buzcarter avatar

Stargazers

Glowstudent avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.