mbr-markdown-browser 0.4.5

A fast, featureful markdown viewer, browser, and (optional) static site generator
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

// UniFFI interface definition for MBR QuickLook plugin
// This defines the FFI boundary between Rust and Swift

namespace mbr {
    // Render a markdown file to self-contained HTML for QuickLook preview
    // Returns complete HTML string suitable for display in WKWebView
    [Throws=QuickLookError]
    string render_preview(string file_path, string? config_root);

    // Render with custom configuration options
    [Throws=QuickLookError]
    string render_preview_with_config(string file_path, string? config_root, QuickLookConfig config);

    // Find the repository/config root directory by searching upward for markers
    // (.mbr, .git, .zk, .obsidian, book.toml, mkdocs.yml, docusaurus.config.js)
    // Falls back to the file's parent directory if no markers found
    string find_config_root(string file_path);
};

// Error types that can be returned from the API
// Using interface-style errors to include descriptive messages
[Error]
interface QuickLookError {
    FileReadError(string message);
    MarkdownRenderError(string message);
    TemplateRenderError(string message);
    ConfigError(string message);
    InvalidPathEncoding();
};

// Configuration options for QuickLook rendering
dictionary QuickLookConfig {
    boolean include_syntax_highlighting;
    boolean include_mermaid;
    string? base_url;
};