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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

//! Full keybinding help overlay, opened with `?`.

use ratatui::Frame;
use ratatui::layout::{Alignment, Constraint, Layout, Margin, Rect};
use ratatui::text::{Line, Span};
use ratatui::widgets::{Block, BorderType, Borders, Clear, Paragraph};

use crate::tui::theme;

const SECTIONS: &[(&str, &[(&str, &str)])] = &[
    (
        "Global",
        &[
            ("q / Ctrl+C", "quit"),
            ("Esc", "back to home / close this help"),
            ("?", "toggle this help"),
        ],
    ),
    (
        "Home",
        &[
            ("↑/↓", "move selection"),
            (
                "1 / 2 / 3",
                "open self-update / book.toml editor / plot generator",
            ),
            ("Enter", "open selected tool"),
        ],
    ),
    (
        "Self-update",
        &[
            ("c", "check for the latest release"),
            ("y / n", "confirm / decline replacing the binary"),
            ("r", "re-check after an error"),
        ],
    ),
    (
        "book.toml editor",
        &[
            ("↑/↓", "select a config item"),
            ("Enter / Space", "edit / toggle the selected item"),
            ("←/→", "cycle enum values"),
            ("a", "show diff and apply"),
            ("y / n", "confirm / cancel writing"),
        ],
    ),
    (
        "Plot generator",
        &[
            ("1-8", "select a plot type"),
            ("↑/↓", "move between form fields"),
            ("type", "edit the selected text field"),
            ("Enter / Space", "toggle a checkbox"),
            ("←/→", "cycle enum values"),
            ("p", "switch output format JSON / TOML"),
            ("c", "copy the generated config to the clipboard"),
            ("s", "save to plot-<type>.json / .toml"),
            ("r", "reset the form to the built-in example"),
            ("Esc", "back to home"),
        ],
    ),
];

pub fn render(frame: &mut Frame, area: Rect) {
    let popup = {
        let [_x] = Layout::horizontal([Constraint::Percentage(64)]).areas(area);
        let [y] = Layout::vertical([Constraint::Percentage(58)]).areas(area);
        y
    };
    let inner = popup.inner(Margin {
        horizontal: 2,
        vertical: 1,
    });
    frame.render_widget(Clear, popup);
    frame.render_widget(
        Block::default()
            .title(" Help ")
            .title_alignment(Alignment::Center)
            .borders(Borders::ALL)
            .border_type(BorderType::Rounded)
            .border_style(theme::border_active())
            .style(ratatui::style::Style::new().bg(theme::Layer::Floating.bg())),
        popup,
    );

    let mut lines: Vec<Line> = Vec::new();
    for (section, rows) in SECTIONS {
        lines.push(Line::from(Span::styled(*section, theme::accent_bold())));
        for (keys, desc) in *rows {
            let keys_w = unicode_width::UnicodeWidthStr::width(*keys);
            lines.push(Line::from(vec![
                Span::styled(format!("  {keys}"), theme::fg()),
                Span::styled(" ".repeat(22usize.saturating_sub(keys_w)), theme::dim()),
                Span::styled(format!("  {desc}"), theme::dim()),
            ]));
        }
        lines.push(Line::from(""));
    }
    frame.render_widget(Paragraph::new(lines).style(theme::fg()), inner);
}