mdbook-plotly 0.3.0

A mdbook preprocessor that renders plot code blocks (e.g., ```plot) into interactive or static charts during book build.
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

//! The TUI application: a single `mdbook-plotly tui` entry point hosting
//! three tools (self-update, book.toml editor, plot generator) plus a
//! welcome view and a help overlay.
//!
//! Network work runs on background threads and reports progress over
//! channels, so the UI never blocks. Effects (fade-in on view change, a
//! short sweep on update completion) come from `tachyonfx` and can be
//! disabled with `--no-effects`.

pub mod app;
pub mod book_toml;
pub mod book_toml_view;
pub mod github;
pub mod help;
pub mod home;
pub mod locale;
pub mod plotgen;
pub mod plotgen_view;
pub mod settings;
pub mod term;
pub mod theme;
pub mod update;
pub mod update_view;
pub mod widget;

use ratatui::Terminal;
use ratatui::backend::CrosstermBackend;

/// Event poll interval in milliseconds.
pub const EVENT_POLL_MS: u64 = 50;

/// View-transition fade-in duration in milliseconds.
pub const VIEW_FADE_MS: u32 = 160;
/// Update-complete sweep duration in milliseconds.
pub const UPDATE_SWEEP_MS: u32 = 180;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum View {
    Home,
    Update,
    Config,
    PlotGen,
}

#[derive(Debug, Clone, Copy, Default)]
pub struct TuiOptions {
    pub dry_run: bool,
    pub no_effects: bool,
    pub no_preview: bool,
}

/// Run the TUI until the user quits.
pub fn run(opts: TuiOptions) -> anyhow::Result<()> {
    term::install_panic_hook();
    let mut terminal = term::setup()?;
    let mut app = app::App::new(opts);
    let result = app.run(&mut terminal);
    let _ = term::teardown(&mut terminal);
    if let Some(text) = app.take_gen_output() {
        println!("{text}");
    }
    result.map_err(Into::into)
}

/// Helper type alias for the terminal used across the app.
pub type TerminalBackend = CrosstermBackend<std::io::Stdout>;
pub type TerminalType = Terminal<TerminalBackend>;