mdbook-rust

Crates.iomdbook-rust
lib.rsmdbook-rust
version0.1.2
sourcesrc
created_at2023-12-01 12:00:41.057633
updated_at2023-12-02 17:11:25.929835
descriptionEnhanced Rust support for MDBook
homepagehttps://github.com/simon-bourne/mdbook-rust
repositoryhttps://github.com/simon-bourne/mdbook-rust
max_upload_size
id1054996
size78,638
Simon Bourne (simon-bourne)

documentation

README

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.

Commit count: 46

cargo fmt