#mdbook #rust-book

bin+lib mdbook-rust

Enhanced Rust support for MDBook

3 releases

0.1.2 Dec 2, 2023
0.1.1 Dec 1, 2023
0.1.0 Dec 1, 2023

#1187 in Text processing

22 downloads per month

MIT/Apache

22KB
275 lines

MDBook Rust

tests crates.io Documentation MIT/Apache-2 licensed

Enhanced Rust support for MDBook.

  • Any chapters written as Rust source files will be translated to Markdown, allowing you to test your book as a Rust crate. It's like literate programming in reverse (illiterate programming).
  • Everything else is left alone.

This Rust code:

fn body() {
    // # Heading
    //
    // Paragraph text.
    some_code();
}

will be converted to:

# Heading

Paragraph text.

```rust,ignore
some_code();
```

See examples/book for a complete example.

Dependencies

~15–29MB
~430K SLoC