https://github.com/jazz-soft/runkit-midi

MIDI player/viewer for RunKit
https://github.com/jazz-soft/runkit-midi

midi midi-file midi-files midi2 runkit

Last synced: about 1 month ago
JSON representation

MIDI player/viewer for RunKit

• Host: GitHub
• URL: https://github.com/jazz-soft/runkit-midi
• Owner: jazz-soft
• Created: 2021-02-20T04:14:47.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-13T03:02:54.000Z (5 months ago)
• Last Synced: 2024-10-13T14:29:52.486Z (3 months ago)
• Topics: midi, midi-file, midi-files, midi2, runkit
• Language: JavaScript
• Homepage:
• Size: 162 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# runkit-midi

MIDI player/viewer for RunKit

[![npm](https://img.shields.io/npm/v/runkit-midi.svg)](https://www.npmjs.com/package/runkit-midi)

[![npm](https://img.shields.io/npm/dt/runkit-midi.svg)](https://www.npmjs.com/package/runkit-midi)

[![build](https://github.com/jazz-soft/runkit-midi/actions/workflows/build.yml/badge.svg)](https://github.com/jazz-soft/runkit-midi/actions)

[![Coverage Status](https://coveralls.io/repos/github/jazz-soft/runkit-midi/badge.svg?branch=main)](https://coveralls.io/github/jazz-soft/runkit-midi?branch=main)

[![Try runkit-midi on RunKit](https://badge.runkitcdn.com/runkit-midi.svg)](https://npm.runkit.com/runkit-midi)

## Your own live MIDI demo on RunKit

[![runkit](https://github.com/jazz-soft/runkit-midi/raw/main/media/runkit.png)](https://npm.runkit.com/runkit-midi)

Have you ever wondered what that `RunKit` button on your NPM page was for?

Does your project generate MIDI files?

You may want to enable a live MIDI demo on your project page.

No install required!

Your visitors will be able to play and view the contents of generated MIDI files as on the image below:

[![screenshot](https://github.com/jazz-soft/runkit-midi/raw/main/media/rkmidi.png)](https://npm.runkit.com/runkit-midi)

## Enabling live MIDI demo on your project page

### Create a demo script:

```js

// my-demo.js

const rkmidi = require('runkit-midi');

const myproj = require('your-project');

const midi = myproj.makeCoolMidi();

rkmidi(midi);

```

### Add an entry into your package.json:

```json

// package.json

  ...

  "runkitExampleFilename": "my-demo.js",

  ...

```

### Add a button to your README.md (optional):

```md

// README.md

  ...

[![Try your-project on RunKit](https://badge.runkitcdn.com/your-project.svg)](https://npm.runkit.com/your-project)

  ...

```

### Publish the new release of your-project on NPM

Have fun!