#book #markdown #mdbook #satysfi

app mdbook-satysfi

A mdbook backend for generating SATySFi documents

5 releases

new 0.0.5 Jun 10, 2021
0.0.4 Jun 10, 2021
0.0.3 Jun 4, 2021
0.0.2 Mar 27, 2021
0.0.1 Jan 27, 2021

#123 in Encoding

26 downloads per month

MIT license

63KB
2K SLoC

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.

  • ✅ compiles successfully
  • ❌ compilation fails/not yet attempted
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

cargo install mdbook-satysfi

Add the following toml configuration to book.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:

cargo uninstall mdbook-satysfi

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

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

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

Build

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

[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")

Dependencies

~10MB
~187K SLoC