rustme 0.1.1

Automatically generate Rusty READMEs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

pub fn main() {
    // begin rustme snippet: example
    let config = rustme::Configuration::load("./examples/basic/.rustme.ron").unwrap();
    config.generate().unwrap();
    // end rustme snippet
}

#[test]
fn check_readme() {
    main();
    let generated =
        std::fs::read_to_string("./examples/basic/README.md").expect("generated file missing");
    assert!(generated.contains("# Basic Example"));
    assert!(generated.contains("## Content"));
    assert!(generated.contains("## Open-source Licenses"));
    // Test snippet loading, as well as common-prefix stripping
    assert!(generated.contains("```rust\nlet config"));
    // Test glossary replacements.
    assert!(generated.contains("https://khonsulabs.com"));
}