https://github.com/owdevel/vscode-markdown-abc

VSCode Markdown Extension for rendering abc notation
https://github.com/owdevel/vscode-markdown-abc

Last synced: about 1 month ago
JSON representation

VSCode Markdown Extension for rendering abc notation

• Host: GitHub
• URL: https://github.com/owdevel/vscode-markdown-abc
• Owner: owdevel
• License: mit
• Created: 2022-02-04T12:01:11.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-08-09T12:47:28.000Z (over 2 years ago)
• Last Synced: 2023-03-06T03:14:46.453Z (almost 2 years ago)
• Language: TypeScript
• Size: 236 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VSCode Markdown Preview ABC Notation Support

Adds support for [abc music notation](https://abcnotation.com/) to VS Code's builtin markdown preview.

## Features

- Render abc notation within code blocks

~~~markdown

```abc

X:1

T:Speed the Plough

M:4/4

C:Trad.

K:G

|:GABc dedB|dedB dedB|c2ec B2dB|c2A2 A2BA|

  GABc dedB|dedB dedB|c2ec B2dB|A2F2 G4:|

|:g2gf gdBd|g2f2 e2d2|c2ec B2dB|c2A2 A2df|

  g2gf g2Bd|g2f2 e2d2|c2ec B2dB|A2F2 G4:|

```

~~~

## Back End

Utilises and packages the [abcjs](https://github.com/paulrosen/abcjs) library for rendering. Currently running on the 6.0.0-beta

## Manual Installation

1. Ensure [vsce](https://www.npmjs.com/package/vsce) is installed via `npm install -g vsce`

2. Clone this git repository

3. Initialise the npm packages `npm install`

4. Package the extension `vsce package`

5. Install into code `code --install-extension vscode-markdown-abc-0.0.1.vsix`

## Future Work

- [ ] Fix Packaging Metadata

- [ ] Add Extension Icon

- [ ] Publish to VSCode Marketplace

- [ ] Publish to Open VSX Registry

- [ ] Display Errors

- [ ] Add support for other renderer options

## Acknowledgements

- This extension is heavily based off of [Markdown Preview Mermaid Support](https://github.com/mjbvz/vscode-markdown-mermaid).

- [ABC.js](https://github.com/paulrosen/abcjs) is the main workhorse rendering the notation. All credits for the interpreter and rendering goes to that team.

- [abc notation](https://abcnotation.com/) is a specification invented by Chris Walshaw to notate music in plain text format. Credits go to him and the other contributors for coming up the specification.