Skip to content
Auto-convert LilyPond snippets in Markdown posts to printed sheet music images
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
spec
.rspec
.ruby-version
Gemfile
Gemfile.lock
README.md
jekyll_lilypond_converter.gemspec

README.md

Jekyll LilyPond Converter

Add lily code blocks to your markdown blog post and automatically convert the code to sheet music using LilyPond.

Installation and Usage

  • Install LilyPond and ensure the lilypond executable is on your $PATH

  • Add this gem to your Jekyll-based static site repository's Gemfile

  • Add lily_images/ to your .gitignore

  • Add the converter to your _config.yml file:

    gems:
    - jekyll-lilypond-converter
    
  • (Optional) specify LilyPond image format in _config.yml (default is svg, alternative option is png)

    lilypond-image-format: png
    
  • Add lily code to a markdown post:

    This is a C major chord:
    
    ```lilypond
    \relative {
      <c' e g>
    }
    ```
    
You can’t perform that action at this time.