rst_renderer 0.4.2

a reStructuredText renderer
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

mod elems_cats;
mod multi;
#[cfg(test)]
pub mod tests;

use std::io::Write;

use anyhow::Error;

// use crate::url::Url;
use document_tree::{Document, HasChildren};

/// Render document as HTML
///
/// # Errors
/// Returns error if serialization fails
pub fn render_html<W>(document: &Document, stream: W, standalone: bool) -> Result<(), Error>
where
    W: Write,
{
    let mut renderer = HTMLRenderer { stream, level: 0 };
    if standalone {
        document.render_html(&mut renderer)
    } else {
        document.children().render_html(&mut renderer)
    }
}

fn escape_html(text: &str) -> String {
    text.replace('&', "&amp;")
        .replace('<', "&lt;")
        .replace('>', "&gt;")
        .replace('"', "&quot;")
}

struct HTMLRenderer<W>
where
    W: Write,
{
    stream: W,
    level: u8,
}

trait HTMLRender {
    fn render_html<W>(&self, renderer: &mut HTMLRenderer<W>) -> Result<(), Error>
    where
        W: Write;
}

pub const FOOTNOTE_SYMBOLS: [char; 10] = ['*', '†', '‡', '§', '¶', '#', '♠', '♥', '♦', '♣'];

pub fn footnote_symbol(n: usize) -> String {
    FOOTNOTE_SYMBOLS
        .iter()
        .cycle()
        .nth(n - 1)
        .unwrap()
        .to_string()
}

const HEAD: &str = r#"<head>
<meta charset="utf-8">
<meta name="color-scheme" content="dark light">
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
@counter-style footnote {
  system: symbolic;
  symbols: '*' '†' '‡' '§' '¶' '#' '♠' '♥' '♦' '♣';
  /*suffix: ' ';*/
}
li.symbol {{ list-style-type: footnote; }}
</style>
</head>"#;

impl HTMLRender for Document {
    fn render_html<W>(&self, renderer: &mut HTMLRenderer<W>) -> Result<(), Error>
    where
        W: Write,
    {
        writeln!(renderer.stream, "<!doctype html>\n<html>\n{HEAD}\n<body>")?;
        self.children().render_html(renderer)?;
        writeln!(renderer.stream, "</body>\n</html>")?;
        Ok(())
    }
}

//------------\\
//Things to do\\
//------------\\

//TODO: prettyprint option list
//TODO: render admonitions: Admonition, Attention, Hint, Note, Caution, Danger, Error, Important, Tip, Warning
//TODO: properly render tables

//TODO: add reference target: FootnoteReference, CitationReference, TitleReference
//TODO: add title: Abbr, Acronym
//TODO: convert math, set display attr
//TODO: add id: Rubric, Target, TargetInline