mdbook-plotly 0.3.0-alpha

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
102
103
104
105
106
107

//! Welcome view: big title, version/variant info, and the three tools.

use ratatui::Frame;
use ratatui::layout::{Alignment, Constraint, Layout, Rect};
use ratatui::style::Modifier;
use ratatui::text::{Line, Span};
use ratatui::widgets::Paragraph;
use tui_big_text::BigText;

use crate::tui::theme;

pub const MENU_ITEMS: [(&str, &str); 3] = [
    (
        "1  Self-update",
        "Check the latest release, download, verify, and replace this binary",
    ),
    (
        "2  Edit book.toml",
        "Tweak the [preprocessor.plotly] configuration with guided edits",
    ),
    (
        "3  Plot cheat-sheet",
        "Search, preview, and copy plot examples from docs/USAGE.md",
    ),
];

#[derive(Debug, Clone, Copy, Default)]
pub struct HomeView {
    pub selected: usize,
}

impl HomeView {
    pub fn render(&mut self, frame: &mut Frame, area: Rect) {
        let [title_area, info_area, menu_area, footer_area] = Layout::vertical([
            Constraint::Length(8),
            Constraint::Length(3),
            Constraint::Min(3),
            Constraint::Length(3),
        ])
        .areas(area);

        let big = BigText::builder()
            .lines(vec![Line::from("mdbook-plotly")])
            .style(theme::accent_bold())
            .alignment(Alignment::Center)
            .build();
        frame.render_widget(big, title_area);

        // This module only compiles in the full (tui) build.
        let info = format!(
            "v{}  ·  full edition  ·  {}",
            env!("CARGO_PKG_VERSION"),
            env!("CARGO_PKG_REPOSITORY")
        );
        frame.render_widget(
            Paragraph::new(Line::from(Span::styled(info, theme::dim())))
                .alignment(Alignment::Center),
            info_area,
        );

        self.render_menu(frame, menu_area);

        frame.render_widget(
            Paragraph::new(Line::from(vec![
                Span::styled("↑↓", theme::accent().add_modifier(Modifier::REVERSED)),
                Span::styled("  select   ", theme::dim()),
                Span::styled("Enter", theme::accent().add_modifier(Modifier::REVERSED)),
                Span::styled("  open", theme::dim()),
            ]))
            .alignment(Alignment::Center),
            footer_area,
        );
    }

    fn render_menu(&mut self, frame: &mut Frame, area: Rect) {
        let item_h = MENU_ITEMS.len() as u16;
        let menu_top = area
            .top()
            .saturating_add(area.height.saturating_sub(item_h) / 2);
        for (i, (title, desc)) in MENU_ITEMS.iter().enumerate() {
            let y = menu_top + i as u16;
            if y >= area.bottom() {
                break;
            }
            let (title_style, desc_style) = if i == self.selected {
                (theme::selected(), theme::selected())
            } else {
                (theme::fg(), theme::dim())
            };
            let title_w = unicode_width::UnicodeWidthStr::width(*title);
            let pad = 42usize.saturating_sub(title_w);
            frame.render_widget(
                Paragraph::new(Line::from(vec![
                    Span::styled(title.to_string(), title_style),
                    Span::styled(" ".repeat(pad), desc_style),
                    Span::styled(desc.to_string(), desc_style),
                ])),
                Rect {
                    x: area.x,
                    y,
                    width: area.width,
                    height: 1,
                },
            );
        }
    }
}