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 |
cargo install mdbook-satysfiAdd the following toml configuration to book.toml.
[output.satysfi]The next mdbook build command will produce SATySFi file in the book/satysfi/ directory.
To uninstall mdbook-satysfi, enter the following in a shell:
cargo uninstall mdbook-satysfiThen delete the [output.satysfi] configuration in book.toml:
- [output.satysfi]- opam 2
- OCaml 4.11.0 (installed by opam)
- Satyrographos
- SATySFi >= "0.0.5" (installed by Satyrographos)
- satysfi-class-mdbook-satysfi >= "0.3.0" (installed by Satyrographos)
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 installAdd the pdf = true configure in [output.satysfi] table:
[output.satysfi]
+ pdf = trueor
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.
mdbook-satysfi is built upon some really wonderful projects, including:
- pulldown-cmark: Parses the markdown source AST.
- html_parser: Parsing the html tag.
(c) 2021 Naoki Kaneko (a.k.a. "puripuri2100")