explaingit

hsablonniere/musiq

18HTMLAudience · vibe coderComplexity · 1/5LicenseSetup · easy

TLDR

A set of six drop-in web components for displaying pianos and guitar fretboards on any website, showing notes, chords, and scales with no framework required.

Mindmap

mindmap
  root((musiq))
    Piano Components
      Plain keyboard
      Chord highlighter
      Scale display
    Fretboard Components
      Base fretboard
      Chord diagram
      Scale viewer
    Instrument Support
      Guitar and bass
      Ukulele
      Custom tunings
    Customization
      CSS color styling
      Note labels
      Fret ranges
    Scales Supported
      Major and minor
      Pentatonic blues
      Modal scales
    Setup
      Single npm install
      Any framework works
      Live demo site
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Add an interactive chord diagram to a music learning app or blog post without writing any custom code.

USE CASE 2

Display a piano keyboard showing which notes belong to a scale on a music theory website.

USE CASE 3

Embed guitar fretboard diagrams in a song-writing tool or tab-sharing site.

USE CASE 4

Visualize how chords look on a ukulele or bass in a beginner music education app.

Tech stack

HTMLWeb ComponentsCSSnpm

Getting it running

Difficulty · easy Time to first run · 5min

Install with one npm command, import the package, then use the custom HTML tags directly. No framework needed. Live demo site available.

MIT license, free to use, modify, and share in personal or commercial projects with no restrictions.

In plain English

musiq is a collection of web components for displaying musical instruments, chords, and scales on a web page. Web components are reusable HTML elements you can drop into any site or web application regardless of what framework it uses. This library provides six components covering pianos and fretboards. The piano components include a plain keyboard for showing any note range, a chord version that highlights the correct keys when you pass in a chord name, and a scale version that colors in the notes of a given scale. Supported scales include major, minor, pentatonic, blues, and the modal scales such as dorian and phrygian. You can control the visual range, switch between key positioning styles, show note labels, and style the colors through standard CSS properties. The fretboard components do the same for stringed instruments. There is a base fretboard that lets you place content on specific positions using named slots, a chord diagram version that takes a chord name and renders finger positions with open and muted string indicators, and a scale version that shows a scale across the full neck. These support guitar, bass, ukulele, custom tunings like drop D, left-handed orientation, and configurable fret ranges. Installing is a single npm command. You import the package and the components become available as custom HTML tags. The project has a documentation and demo site where you can see all six components in action with live examples. It is MIT licensed.

Copy-paste prompts

Prompt 1
Using the musiq web component library, show me how to embed a piano that highlights a C major chord on my HTML page.
Prompt 2
How do I use the musiq fretboard component to display a G minor pentatonic scale for a left-handed guitar player?
Prompt 3
Give me example HTML using musiq to show a ukulele chord diagram for an Am chord, including open and muted strings.
Prompt 4
How can I change the highlight colors on a musiq piano scale component using CSS custom properties?
Prompt 5
Walk me through adding musiq to a plain HTML file with no build tools, just a script tag and npm install.
Open on GitHub → Explain another repo

← hsablonniere on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.