#markdown #pulldown-cmark #stage #play

bin+lib mdbook-playscript

Preprocessor for mdBook, which styles stage play scripts

7 releases (4 breaking)

0.5.0 Sep 4, 2021
0.4.0 Mar 6, 2021
0.3.2 Feb 5, 2021
0.2.0 Jan 30, 2021
0.1.0 Jan 30, 2021

#2 in #pulldown-cmark

44 downloads per month

MPL-2.0 license

41KB
393 lines

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.

Dependencies

~12MB
~214K SLoC