mdbook-gabc 0.0.1

mdbook preprocessor to add gabc support
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

# mdbook-gabc

A preprocessor for [mdbook][] to add gabc support.

[mdbook]: https://github.com/rust-lang-nursery/mdBook
[gabc]: https://gregorio-project.github.io/gabc/

It turns this:

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

into this:

![Simple Chant](simple-chant.png)

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`:

```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`](src/bin/assets) directory.

Finally, build your book:

```
mdbook path/to/book
```

## License

MPL. See [LICENSE](LICENSE).  
Copyright (c) 2023 Joseph Leano <josephleano@gmail.com>

Exsurge is [MIT licensed](https://github.com/frmatthew/exsurge/blob/master/LICENSE).
The bundled assets (`exsurge.min.js`) are MIT licensed.