Replace mdBook with Typst

[burrbull]

This is my answer to multi-language book. cc @hwhsu1231

We can keep translations in same file if use Typst instead. See typ/intro/index.typ for example.

This is a draft yet, but it is already looks and works very similar to mdBook version as it reuses original CSS and scripts.

How to compile:
English:

cp -a typ/mdbook/assets/. book/
typst compile typ/book.typ --input lang=en --input target=html book --features bundle,html -f bundle
typst compile typ/book.typ --input lang=en --input target=pdf book/rust_embedded_book_en.pdf

German:

typst compile typ/book.typ --input lang=de --input target=html book/de --features bundle,html -f bundle
typst compile typ/book.typ --input lang=de --input target=pdf book/rust_embedded_book_de.pdf

See rendered PDF:
rust_embedded_book_en.pdf

[hwhsu1231]

Hello @burrbull,

Thank you for tagging me in this draft PR.

First of all, if you are asking for my opinion on this PR, I'm not entirely in favor of this change. Since you tagged me, I assume you've likely seen the rust-embedded-book-l10n project I announced in #401. Therefore, if rust-embedded/book migrates from mdBook to another documentation generator, this l10n project will no longer be able to function (unless the new tool also supports gettext-based internationalization).

Additionally, I noticed you mentioned the German translation in #415. If you are interested in translating The Embedded Rust Book, you are more than welcome to join the rust-embedded-book-l10n project! If German is not available yet, feel free to open an issue to request adding a new language. Once the requested language is added, you can start translating right away!

[burrbull]

CI caching does not work. What I did wrong?

All works as expected except one thing with sidebar in localized book.
When js is disabled iframe[ toc.html ] and it works well although it is not interactive.
When js is enabled magic toc.js works which always generates English table of contents.

P.S. It would be nice to add some html formatter in CI.

[burrbull]

Added German translation from #415. @braunharald please review.
cc @eldruin @therealprof

rust_embedded_book_en.pdf
rust_embedded_book_de.pdf

[braunharald]

I think I still have a bit of trouble understanding this. Should I just compare the two PDF files and let you know whether I think the implementation is good or bad? Or is there a branch on GitHub for the “typ” directory and its subdirectories so that I can put together a patch if necessary? If so, I'd appreciate the link. /Harald Am 04.08.26 um 17:43 schrieb Zgarbul Andrey:

*burrbull* left a comment (rust-embedded/book#416) <#416 (comment)> Added German translation from #415 <#415>. @braunharald <https://github.com/braunharald> please review. cc @eldruin <https://github.com/eldruin> @therealprof <https://github.com/therealprof> rust_embedded_book_en.pdf <https://github.com/user-attachments/files/30710500/rust_embedded_book_en.pdf> rust_embedded_book_de.pdf <https://github.com/user-attachments/files/30710506/rust_embedded_book_de.pdf> — Reply to this email directly, view it on GitHub <#416?email_source=notifications&email_token=ASFDTGBIKIYUYNF3EY6QDIT5IIABVA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTKMJYGEZTINBVGYZKM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLDGN5XXIZLSL5RWY2LDNM#issuecomment-5181344562>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ASFDTGGCGXITFVP74GNMCAT5IIABVAVCNFSNUABFKJSXA33TNF2G64TZHMYTINBSGE2TSMJXHNEXG43VMU5TKMBTHAYTCOJRG422C5QC>. Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS <https://github.com/notifications/mobile/ios/ASFDTGDC4MPREDLHQ557VEL5IIABVA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTKMJYGEZTINBVGYZKM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJKTGN5XXIZLSL5UW64Y> and Android <https://github.com/notifications/mobile/android/ASFDTGCH4ZKH43RRPXW3WW35IIABVA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTKMJYGEZTINBVGYZKM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLTGN5XXIZLSL5QW4ZDSN5UWI>. Download it today! You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Mit freundlichem Gruß Harald Braun In der Aue 6 36282 Hauneck-Rotensee Tel.: +49 6621 7966123 ***@***.***

[burrbull]

I think I still have a bit of trouble understanding this.

There is example in first message how you could to compile the book locally.
But first you need to install typst with

cargo install typst-cli

In book and book/de directories will be generated html and pdf files.

The original text and translation were added manually.
So I'd want you to look over book and say what is wrong or missing. For example intro/install/index.md is missing in archive you've uploaded in #415.
It is easy to see in PDF. Feel free to make PR in https://github.com/burrbull/book/tree/typst
It is also interesting to know how hard to do it for another people.

P.S. My recommendations to use vs code:

1. Install typst extension.
2. Go to settings.json and change language in --input=lang.
3. Go to book-pdf.typ and press button to watch pdf preview in real time.