lilypond-mkdocs-plugin

MkDocs plugin supporting LilyPond (notation software) input

NOTE: This is a very preliminary "initial commit"-like repository.

---

This plugin provides support for LilyPond input in Markdown files processed with MkDocs. If it is installed and activated fenced code blocks with the lilypond language are highlighted using the python-ly package which powers the Frescobaldi IDE.

At this point syntax highlighting without any configuration is all the plugin provides. There will be further options, and hopefully the possibility to actually use LilyPond to produce musical scores, but that is out of scope right now.

Installation

Until we consider uploading this to PyPi the plugin may only be installed from the GitHub repository, either by issuing

(sudo) pip3 install git+https://github.com/uliska/lilypond-mkdocs-plugin.git

or - from within a download directory

(sudo) pip3 install -e .

The latter is preferable if you want to contribute to the plugin. In this case the install command has to be repeated after any modification. However, it seems that dependencies are not automatically installed this way, so you'll have to install the mkdocs and python-ly packages separately.

Using sudo or not is probably a matter of personal taste; however, it is crucial to stick to one approach across the board to ensure everything works together.

Usage

In a MkDocs mkdocs.yml file, simply add

plugins:
  - search
  - lilypond

NOTE: Adding a plugins section will deactivate the default search plugin, so you will probably want to add it manually.

Now your rendered site will have highlighted LilyPond input automatically.