fml 0.6.5

Friendly Markup Language
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
108
109
110
111

use derive_deref::{Deref, DerefMut};
use std::io::{self, ErrorKind::Unsupported};

#[derive(Deref, DerefMut, Default, PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
pub struct Content(pub Vec<Section>);

// #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
// pub struct Values(pub Vec<FmlValue>);

#[derive(Deref, DerefMut, Default, PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
pub struct Section(pub FmlValues);

#[derive(Deref, DerefMut, Default, Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
pub struct FmlValues(pub Vec<FmlValue>);

#[derive(Deref, DerefMut, PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
pub struct ListItem(pub FmlValues);

#[derive(Deref, DerefMut, PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
pub struct FmlList(pub Vec<ListItem>);

#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
pub enum FmlValue {
    /// Linebreak, for convenience between environments.
    Linebreak,

    /// Equivalent of HTML's <h1>, spans entire line. "# "
    Heading1(FmlValues),
    /// Equivalent of HTML's <h2>, spans entire line. "## "
    Heading2(FmlValues),
    /// Equivalent of HTML's <h3>, spans entire line. "### "
    Heading3(FmlValues),

    /// Superscript spanning the entire line. "#^"
    Superline(FmlValues),
    /// Subscript spanning the entire line. "#_" or "#!"
    Subline(FmlValues),

    /// Bold text "*"
    Bold(FmlValues),
    /// Italicized text "_"
    Italic(FmlValues),
    /// Strikethrough text "~"
    Strikethrough(FmlValues),

    /// Quote, is its own section. "> "
    Quote(FmlValues),
    List(FmlList),

    /// Superscript. "^{body}"
    Superscript(FmlValues),
    /// Subscript. "_{body}"
    Subscript(FmlValues),
    /// Underlined text. "__"
    Underline(FmlValues),

    /// Colored foreground, uses HTML color name or 6-digit hexadecimal RRGGBB with a "0x" or "#" prefix.\
    /// "#fg<blue>{body}" or "#color<0x00FF00>{body}"
    ColorFg(FmlColor),

    /// Colored background, uses HTML color name or 6-digit hexadecimal RRGGBB with a "0x" or "#" prefix.\
    /// "#bg<blue>{body}" or "#bg<0x00FF00>{body}"
    ColorBg(FmlColor),

    /// Content-warning. "#cw<reason>{body}" or "|spoiler|"
    ContentWarning {
        reason: String,
        body: FmlValues,
    },

    /// Code-block, optional `lang` var for syntax-highlighting. "```"
    CodeBlock {
        lang: Option<String>,
        body: String,
    },

    // TODO: document
    Hyperlink {
        fml: FmlValues,
        uri: String,
    },

    /// Inline code. "`"
    CodeInline(String),

    /// Typst block. Its body gets passed to the typst compiler.
    Typst(String),

    /// Bottom-most element of every other FmlValue,
    /// a catch-all for whatever does not belong in the other tokens.
    Text(String),
}

#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
pub enum FmlCodeBlockValue {
    Str(String),
    Linebreak,
}

// #[derive(Debug, Default, PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
// pub struct FmlFunction {
//     pub name: String,
//     pub params: Option<String>,
//     pub body: FmlValues,
// }

#[derive(Debug, Default, PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
pub struct FmlColor {
    pub color: String,
    pub body: FmlValues,
}