mdbook-satysfi

crates.io Build Status source badge license badge

Status of Rust Bookshelf

note: The PDF file was generated by manually runnig the satysfi command.

| Source | Generate SATySFi | Generate PDF | Online Version | | :---------------------------------- | :---------------: | :------------: | :---------------------- | |Rust Programming Language| ✅ | ✅ | HTML | |Mdbook User Guide | ✅ | ✅ |HTML | |Rust By Example | ✅ | ✅ |HTML | |Edition Guide | ✅ | ✅ |HTML | |Rustc Book | ✅ | ✅ |HTML | |Cargo Book | ✅ | ✅ |HTML | |Rustdoc Book | ✅ | ✅ |HTML | |Rust Reference | ✅ | ✅ |HTML | |Rustonomicon | ✅ | ✅ |HTML| |Embedded Rust Book | ✅ | ✅ |HTML |

Installation

Requirements

Cargo install + Configuration

sh cargo install mdbook-satysfi

Add the following toml configuration to book.toml.

toml [output.satysfi]

The next mdbook build command will produce SATySFi file in the book/satysfi/ directory.

Uninstallation

To uninstall mdbook-satysfi, enter the following in a shell:

sh cargo uninstall mdbook-satysfi

Then delete the [output.satysfi] configuration in book.toml:

diff - [output.satysfi]

Build PDF file

Requirements

To install opam, satyrographos and SATySFi, see this link.

To install satysfi-class-mdbook-satysfi, run the following command :

sh opam update opam install satysfi-class-mdbook-satysfi satyrographos install

Build

Add the pdf = true configure in [output.satysfi] table:

diff [output.satysfi] + pdf = true

or

Please run :

satysfi book/satysfi/main.saty

note : SATySFi does not support image formats other than JPEG. So if you are using a format other than JPEG, please replace it manually.

Primary Dependencies

mdbook-satysfi is built upon some really wonderful projects, including:


(c) 2021 Naoki Kaneko (a.k.a. "puripuri2100")