Open Lyric for VS Code
Write songs in Open Lyric — markdown with fenced song sections (ol:Config,
ol:Verse 1, ol:Chorus, …), chords in brackets over the lyrics — and see them
rendered as you type.
Files named *.ol.md open as Open Lyric documents.
Features
- Syntax highlighting of fences, section titles,
Config fields, chords,
directives, bars, repeats and notes — generated from the same tokenizer as
the Open Lyric web editor, scoped with standard TextMate names so every colour
theme paints it.
- Validation in the Problems panel as you type: unknown or misspelled
section headers, a missing
ol:Config, invalid Config values, chord and
bar mistakes, Structure references — the web editor's validator, unchanged.
- Snippets for every section: type
ol: (or ```ol:) and pick
ol:Verse 1, ol:Chorus, ol:Config, …
- Live preview (
Ctrl+Shift+V / Cmd+Shift+V, or Ctrl+K V /
Cmd+K V to the side): the Lyric view (sections, chords over lyrics,
Config details) and the Markdown view (the document with each fence
rendered as a card). Like the Markdown preview, each editor group can have
its own preview that follows the active Open Lyric editor, and a locked
preview stays on one song, so several songs can be previewed side by side.
Split Editor on a preview opens another preview of the same song, so it
can show the Lyric and Markdown views at once.
The theme picker in its toolbar follows VS Code's light/dark theme
(Follow IDE, the default) or pins a custom theme: Light, Dark,
Bootstrap Light or Bootstrap Dark.
- Strum player in the preview: a ▶ on each strumming-pattern card, a
click on a chord plays it, and an Instrument picker (ten instruments)
in the preview's settings popup.
- Examples: Open Lyric: Open Example… opens a bundled song as a new
document.
- Folding of each
```ol: fence, // line comments, bracket matching.
Languages
The core is language-neutral. Language extensions plug spellcheckers, example
songs and preview fonts into it — install Open Lyric Khmer
(raksa.open-lyric-khmer) for Khmer: it brings Khmer Lint's
(raksa.khmer-lint) spellcheck with word segmentation and Khmer fonts into
songs and the preview, and installs both this extension and Khmer Lint with it.
Settings
| Setting |
Default |
Effect |
openLyric.validation.enable |
true |
Report notation problems. |
openLyric.spellcheck.enable |
true |
Run the spellcheckers language extensions provide. |
openLyric.spellcheck.customWords |
{} |
Accepted words per language code, e.g. { "km": ["…"] }. |
openLyric.preview.defaultView |
"lyric" |
The view a new preview opens in: "lyric" or "markdown". |
openLyric.preview.theme |
"follow-ide" |
The preview's theme: "follow-ide", or a custom "light", "dark", "light-bs" or "dark-bs". The toolbar's theme picker writes here. |
Commands
| Command |
Keybinding |
| Open Lyric: Open Preview |
Ctrl+Shift+V / Cmd+Shift+V |
| Open Lyric: Open Preview to the Side |
Ctrl+K V / Cmd+K V |
| Open Lyric: Open Locked Preview to the Side |
|
| Open Lyric: Toggle Preview Locking |
|
| Open Lyric: Show Source |
|
| Open Lyric: Open Example… |
|
| |