mdbook-gabc

Crates.iomdbook-gabc
lib.rsmdbook-gabc
version0.0.1
sourcesrc
created_at2023-09-21 20:35:03.578759
updated_at2023-09-21 20:35:03.578759
descriptionmdbook preprocessor to add gabc support
homepagehttps://github.com/jleano/mdbook-gabc
repositoryhttps://github.com/jleano/mdbook-gabc
max_upload_size
id980017
size247,333
jleano (jleano)

documentation

README

mdbook-gabc

A preprocessor for mdbook to add gabc support.

It turns this:

```gabc
(f3) EC(ce!fg)CE(f) *(,) ad(fe~)vé(f!gwhf)nit(f) (,)
```

into this:

Simple Chant

in your book.

Installation

If you want to use only this preprocessor, install the tool:

cargo install mdbook-gabc

Then let mdbook-gabc add the required files and configuration:

mdbook-gabc install path/to/your/book

This will add the following configuration to your book.toml:

[preprocessor.gabc]
command = "mdbook-gabc"

[output.html]
additional-js = ["exsurge.min.js", "exsurge-init.js"]

It will skip any unnecessary changes and detect if mdbook-gabc was already configured.

Additionally it copies the files exsurge.min.js and exsurge-init.js into your book's directory. You find these files in the src/bin/assets directory.

Finally, build your book:

mdbook path/to/book

License

MPL. See LICENSE.
Copyright (c) 2023 Joseph Leano josephleano@gmail.com

Exsurge is MIT licensed. The bundled assets (exsurge.min.js) are MIT licensed.

Commit count: 9

cargo fmt