Getting Started

Prerequisites

1. The LilyPond binary must be installed.
   • Install the LilyPond binary, or run brew install lilypond (Mac) or apt install lilypond (Linux).
   • Verify the install with lilypond --version.
2. You should have an astro project running v7.0 or newer.
   • Install Astro.

Installation

1. Install astro-lilypond.

   pnpm

   pnpm add astro-lilypond

   npm

   npm install astro-lilypond

   yarn

   yarn add astro-lilypond

2. Add the integration to your Astro config.

   astro.config.mjs

   import { defineConfig } from 'astro/config';
   import lilypond from 'astro-lilypond';
   
   export default defineConfig({
     integrations: [lilypond()],
   });

   See Configuration for available options.

3. Start writing LilyPond. See Usage for Markdown and component-based approaches.