mdbook-obsidian 0.1.0

mdBook preprocessor to render Obsidian specific syntax
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

use mdbook::book::Book;
use mdbook::book::{BookItem, Chapter};
use mdbook::errors::Error;
use mdbook::preprocess::{Preprocessor, PreprocessorContext};
use rust_embed::RustEmbed;

mod callouts;

#[derive(RustEmbed)]
#[folder = "assets/"]
pub struct Asset;

/// The Obsidian preprocessor.
pub struct Obsidian;

impl Default for Obsidian {
    fn default() -> Self {
        Self::new()
    }
}

impl Obsidian {
    pub fn new() -> Obsidian {
        Obsidian
    }
}

impl Preprocessor for Obsidian {
    fn name(&self) -> &str {
        "Obsidian"
    }

    fn run(&self, _ctx: &PreprocessorContext, mut book: Book) -> Result<Book, Error> {
        let mut error: Option<Error> = None;
        book.for_each_mut(|item: &mut BookItem| {
            if error.is_some() {
                return;
            }
            if let BookItem::Chapter(ref mut chapter) = *item {
                if let Err(err) = handle_chapter(chapter) {
                    error = Some(err)
                }
            }
        });
        error.map_or(Ok(book), Err)
    }

    /// Check whether we support the specified renderer
    fn supports_renderer(&self, renderer: &str) -> bool {
        renderer == "html"
    }
}

/// Apply to all chapters
fn handle_chapter(chapter: &mut Chapter) -> Result<(), Error> {
    chapter.content = callouts::render(&chapter.content)?;
    // Add your additional syntax parsing here

    Ok(())
}