doubter

A helper crate for testing Rust code blocks in Markdown.

This crate works similarly to #![doc(include = "...")], but it does not require the nightly Rust toolchain.

Usage

First create a new crate for testing Markdown files. This crate must be separated from all published crates.

Next, add the dependencies for doubter to Cargo.toml. If some external crates are used in some code blocks, specify it as [dev-dependencies]:

[dependencies]
doubter = "0.0.4"

[dev-dependencies]
# put here additional dependencies used in code blocks.
rand = "*"
...

Finally modify src/lib.rs to specify the path to target Markdown files. All paths specified here must be the relative path from Cargo's manifest directory.

#[macro_use]
extern crate doubter;

doubter! {
    file = "doc/print_foo.md",
    file = "README.md",
}

Status

Experimental (see also the roadmap issue)

Alternatives

• skeptic
• docmatic

License

MIT license