microsoft / microsoft/rust-for-dotnet-devs
Render the book to PDF with `mdbook-pandoc`
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 405
- Forks
- 61
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
Hey there,
@max-heller was a great help to comprehensive-rust and rust-patterns as they helped us set up rendering to PDF.
mdbook-pandoc has some pre-rendered examples in also of Rust-by-example and the book: https://github.com/max-heller/mdbook-pandoc?tab=readme-ov-file#rendered-books
-
Comprehensive Rust: https://google.github.io/comprehensive-rust/comprehensive-rust.pdf
-
Rust Design Patterns: https://rust-unofficial.github.io/patterns/rust-design-patterns.pdf
Some Resources
-
Initial support PR: https://github.com/rust-unofficial/patterns/pull/394
-
Adding download icon to menu bar: https://github.com/rust-unofficial/patterns/commit/d96de404c45f17310c3eb77b4669d715ce923d33
-
Line wrapping in code blocks: https://github.com/rust-unofficial/patterns/commit/3dd157b9d751e2a5a391b2933ae6eb8467ea1eaf
-
Readme of
mdbook-pandoc: https://github.com/max-heller/mdbook-pandoc?tab=readme-ov-file#getting-started
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the mdbook-pandoc README and the referenced Rust Design Patterns support PR, then inspect this repository's book-rendering configuration. Compare the generated output with the linked Comprehensive Rust and Rust Design Patterns PDFs. Done means the book renders successfully to a usable PDF and the relevant download or access path is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100