mdbook-playscript
| Crates.io | mdbook-playscript |
| lib.rs | mdbook-playscript |
| version | 0.5.0 |
| source | src |
| created_at | 2021-01-30 03:30:45.130583 |
| updated_at | 2021-09-04 03:54:22.876768 |
| description | Preprocessor for mdBook, which styles stage play scripts |
| homepage | |
| repository | https://github.com/ShotaroTsuji/mdbook-playscript |
| max_upload_size | |
| id | 348341 |
| size | 124,677 |
Shotaro Tsuji (ShotaroTsuji)
documentation
README
mdbook-playscript
An mdBook preprocessor for writing stage play scripts. The library crate of this preprocessor is mdplayscript.
If you are a Japanese user, read Japanese README, would you?
License
License is changed in the version 0.3.0.
The source codes written in Rust and CSS files are licensed under MPL-2.0.
Markdown files in examples/figaro/ are licensed under CC BY-SA 3.0, because they are copied from WikiSource and formatted by the author of this crate.
Markdown files in examples/torikaeshi/ are in public domain, because they are copied from Aozora Bunko (in Japanese) and formatted by the author of this crate.
Install
You can install this preprocessor with cargo:
cargo install mdbook-playscript
Other installation methods are not provided now.
Usage
You can use mdbook-playscript preprocessor by adding the following config to your book.toml.
You must specify the additional-css for the HTML backend by hand.
[preprocessor.playscript]
command = "mdbook-playscript"
[output.html]
additional-css = ["mdplayscript.css"]
Examples
The README of mdplayscript explains basic notations.
An example of a source of a book preprocessed with mdbook-playscript is placed in examples/figaro.
The generated example is hosted on github pages.