mdbook-utils 0.1.3

Tools to manage links, reference definitions, and code examples in Markdown files, especially `mdbook` source directories.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

//! Create reference definitions from dependencies.

use std::borrow::Cow;
use std::collections::BTreeMap;

use tracing::info;

use crate::dependencies::Dependency;
use crate::link::Link;

/// Create reference definitions from dependencies
///
/// dependencies: sorted map of dependencies
pub(crate) fn generate_refdefs_from(
    dependencies: BTreeMap<Cow<'_, str>, Dependency<'_>>,
) -> Vec<Link<'static>> {
    let mut buf = Vec::new();
    for (_, dep) in dependencies {
        info!("{:?}", dep);
        buf.push(generate_refdefs_for_one_library(
            &dep.library_name,
            dep.package_repo_url.as_deref(),
        ));
    }
    buf.into_iter().flatten().collect::<Vec<_>>()
}

// TODO
/// Create, for a given crate, multiple reference definitions for
/// common websites such as docs.rs, crates.io, github,
/// and the associated badge URLs
fn generate_refdefs_for_one_library(
    _library_name: &str,
    _package_repo_url: Option<&str>,
) -> Vec<Link<'static>> {
    // let mut buf = Vec::new();

    // // [arrow-rs]: https://docs.rs/arrow/
    // let docs_rs_url = format!("https://docs.rs/{}", library_name);

    // // [config-crate]: https://crates.io/crates/config/
    // let crates_io_lbl = format!("{}-crate", library_name);
    // let crates_io_url = format!("https://crates.io/crates/{}", library_name);

    // // [arrow-rs-github]: https://github.com/apache/arrow-rs/
    // let github_lbl = format!("{}-github", library_name);

    // info!("{}", badge_image_url.to_string());
    // let link = crate::link::LinkBuilder::default()
    //     .set_label(library_name)
    //     //.set_url()
    //     .set_image_url(badge_image_url.to_string())
    //     .build();

    // buf

    Vec::new()
}

#[cfg(test)]
mod test {
    // use super::*;

    // #[test]
    // fn test() {
    // }
}