/VSLilyPond-PDF-preview

Provides PDF Preview for LilyPond-generated PDFs. Supports point-and-click from PDF to source code.

Primary LanguageTypeScriptMIT LicenseMIT

LilyPond PDF Preview

Visual Studio Marketplace Visual Studio Marketplace

Provides PDF Preview for LilyPond-generated PDFs. Supports point-and-click from PDF to source code.

Included in the VSLilyPond extension.

Features

Two-way Point and Click 📄

Forward (Score to PDF)

Forward Point-and-Click

Backward (PDF to Score)

Backward Point-and-Click

Requirements

  • (Optional but recommended): VSLilyPond -- Provides advanced LilyPond language support

Usage Guide

  • Open your LilyPond-compiled PDF in VSCode using the LilyPond PDF Preview option. If you have multiple PDF previewer extensions, make sure that you choose LilyPond PDF Preview when opening the file. Step 1 Step 2

  • Forward point-and-click

    • Click on the code location you are interested in, then execute the LilyPond PDF Preview: Go to PDF location from Cursor command
      • Press Ctrl/Cmd + Shift + P to open the Command Palette
      • It is advisable to bind a shortcut to this feature as you please via the Command Palette
  • Backward point-and-click

    • Click on any of the noteheads etc..

Extension Settings

Issues

Please submit issues in the GitHub repository.

Contributing

Development

Requirements

Setup

  • Clone repository

    git clone https://github.com/lhl2617/VSLilyPond-PDF-preview
  • Install npm dependencies

    npm i
  • Hit F5 to run an Extension Development Host.

    See here for a detailed extension development guide.

Releasing

Releasing is done automatically via GitHub Actions. Bump the version in package.json and update CHANGELOG.md before merging into the default branch.

Acknowledgements

  • This extension is based on tomoki1207/vscode-pdf, licensed under the MIT License.
  • This extension bundles pdf.js, licensed under the Apache License 2.0.