Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
simon-bourne committed Dec 1, 2023
1 parent 31aac4c commit 9986813
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,31 @@
[![MIT/Apache-2 licensed](https://img.shields.io/crates/l/mdbook-rust)](./LICENSE-APACHE)

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:

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

will be converted to:

````markdown
# Heading

Paragraph text.

```rust
some_code();
```
````

See [`examples/book`](https://github.com/simon-bourne/mdbook-rust/tree/main/examples/book) for a complete example.

0 comments on commit 9986813

Please sign in to comment.