puripuri2100 / mdbook-satysfi

A mdbook backend for generating SATySFi documents.

mdbook-satysfi

• Documentation(ja)
• Documentation PDF(ja)

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

• Rust
• mdbook

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

• opam 2
  • See https://opam.ocaml.org/doc/Install.html.
• 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 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:

• pulldown-cmark: Parses the markdown source AST.
• html_parser: Parsing the html tag.

---

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

mdbook-satysfi's Issues

Cannot build pdf due to lacking package

I installed SATySFi using the instruction in the README and installed mdbook-satysfi v0.0.2 using cargo. After running mdbook build, satysfi book/satysfi/main.saty, it didn't build with an error:

$ satysfi book/satysfi/main.saty
 ---- ---- ---- ----
  target file: 'main.pdf'
  dump file: 'main.satysfi-aux' (will be created)
  parsing 'main.saty' ...
! [Error] package file not found:
      class-mdbook-satysfi/mdbook-satysfi
    candidate paths:
      $PROJECT_DIR/.satysfi/local/packages/class-mdbook-satysfi/mdbook-satysfi.satyh
      $PROJECT_DIR/.satysfi/local/packages/class-mdbook-satysfi/mdbook-satysfi.satyg
      $HOME/.satysfi/local/packages/class-mdbook-satysfi/mdbook-satysfi.satyh
      $HOME/.satysfi/local/packages/class-mdbook-satysfi/mdbook-satysfi.satyg
      /usr/local/share/satysfi/local/packages/class-mdbook-satysfi/mdbook-satysfi.satyh
      /usr/local/share/satysfi/local/packages/class-mdbook-satysfi/mdbook-satysfi.satyg
      /usr/share/satysfi/local/packages/class-mdbook-satysfi/mdbook-satysfi.satyh
      /usr/share/satysfi/local/packages/class-mdbook-satysfi/mdbook-satysfi.satyg
      $HOME/Quell/conlang/.satysfi/dist/packages/class-mdbook-satysfi/mdbook-satysfi.satyh
      $HOME/Quell/conlang/.satysfi/dist/packages/class-mdbook-satysfi/mdbook-satysfi.satyg
      $HOME/.satysfi/dist/packages/class-mdbook-satysfi/mdbook-satysfi.satyh
      $HOME/.satysfi/dist/packages/class-mdbook-satysfi/mdbook-satysfi.satyg
      /usr/local/share/satysfi/dist/packages/class-mdbook-satysfi/mdbook-satysfi.satyh
      /usr/local/share/satysfi/dist/packages/class-mdbook-satysfi/mdbook-satysfi.satyg
      /usr/share/satysfi/dist/packages/class-mdbook-satysfi/mdbook-satysfi.satyh
      /usr/share/satysfi/dist/packages/class-mdbook-satysfi/mdbook-satysfi.satyg

I believe class-mdbook-satysfi/mdbook-satysfi is supposed to be installed on the installation of the crate, but wasn't. Is there any scenario where this can happen?