mdbook 0.5.2

Creates a book from markdown files
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178

//! Tests for theme handling.

use crate::prelude::*;

// Checks what happens if the theme directory is missing.
#[test]
fn missing_theme() {
    BookTest::from_dir("theme/missing_theme").run("build", |cmd| {
        cmd.expect_failure().expect_stderr(str![[r#"
 INFO Book building has started
 INFO Running the html backend
ERROR Rendering failed
[TAB]Caused by: theme dir [ROOT]/./non-existent-directory does not exist

"#]]);
    });
}

// Checks what happens if the theme directory is empty.
#[test]
fn empty_theme() {
    BookTest::from_dir("theme/empty_theme").run("build", |cmd| {
        std::fs::create_dir(cmd.dir.join("theme")).unwrap();
        cmd.expect_stderr(str![[r#"
 INFO Book building has started
 INFO Running the html backend
 INFO HTML book written to `[ROOT]/book`

"#]]);
    });
}

// Checks overriding index.hbs.
#[test]
fn override_index() {
    BookTest::from_dir("theme/override_index").check_file(
        "book/index.html",
        str![[r#"
This is a modified index.hbs!

"#]],
    );
}

// After building, what are the default set of fonts?
#[test]
fn default_fonts() {
    BookTest::init(|_| {})
        .check_file_contains("book/index.html", "fonts/fonts-[..].css")
        .check_file_list(
            "book/fonts",
            str![[r#"
book/fonts/OPEN-SANS-LICENSE.txt
book/fonts/SOURCE-CODE-PRO-LICENSE.txt
book/fonts/fonts-[..].css
book/fonts/open-sans-v17-all-charsets-300-[..].woff2
book/fonts/open-sans-v17-all-charsets-300italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-600-[..].woff2
book/fonts/open-sans-v17-all-charsets-600italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-700-[..].woff2
book/fonts/open-sans-v17-all-charsets-700italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-800-[..].woff2
book/fonts/open-sans-v17-all-charsets-800italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-regular-[..].woff2
book/fonts/source-code-pro-v11-all-charsets-500-[..].woff2
"#]],
        );
}

// When the theme is initialized, what does the fonts list look like?
#[test]
fn theme_fonts_copied() {
    BookTest::init(|bb| {
        bb.copy_theme(true);
    })
    .check_file_contains("book/index.html", "fonts/fonts-[..].css")
    .check_file_list(
        "theme/fonts",
        str![[r#"
theme/fonts/OPEN-SANS-LICENSE.txt
theme/fonts/SOURCE-CODE-PRO-LICENSE.txt
theme/fonts/fonts.css
theme/fonts/open-sans-v17-all-charsets-300.woff2
theme/fonts/open-sans-v17-all-charsets-300italic.woff2
theme/fonts/open-sans-v17-all-charsets-600.woff2
theme/fonts/open-sans-v17-all-charsets-600italic.woff2
theme/fonts/open-sans-v17-all-charsets-700.woff2
theme/fonts/open-sans-v17-all-charsets-700italic.woff2
theme/fonts/open-sans-v17-all-charsets-800.woff2
theme/fonts/open-sans-v17-all-charsets-800italic.woff2
theme/fonts/open-sans-v17-all-charsets-italic.woff2
theme/fonts/open-sans-v17-all-charsets-regular.woff2
theme/fonts/source-code-pro-v11-all-charsets-500.woff2
"#]],
    )
    // Note that license files get hashed, which is not like the behavior when
    // the theme directory is empty. It kinda makes sense, but is weird.
    .check_file_list(
        "book/fonts",
        str![[r#"
book/fonts/OPEN-SANS-LICENSE-[..].txt
book/fonts/SOURCE-CODE-PRO-LICENSE-[..].txt
book/fonts/fonts-[..].css
book/fonts/open-sans-v17-all-charsets-300-[..].woff2
book/fonts/open-sans-v17-all-charsets-300italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-600-[..].woff2
book/fonts/open-sans-v17-all-charsets-600italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-700-[..].woff2
book/fonts/open-sans-v17-all-charsets-700italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-800-[..].woff2
book/fonts/open-sans-v17-all-charsets-800italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-regular-[..].woff2
book/fonts/source-code-pro-v11-all-charsets-500-[..].woff2
"#]],
    );
}

// Custom fonts.css.
#[test]
fn fonts_css() {
    BookTest::from_dir("theme/fonts_css")
        .check_file_contains("book/index.html", "fonts/fonts-[..].css")
        .check_file(
            "book/fonts/fonts-*.css",
            str![[r#"
/*custom*/

"#]],
        )
        .check_file("book/fonts/myfont-*.woff", str![[""]])
        .check_file_list(
            "book/fonts",
            str![[r#"
book/fonts/fonts-[..].css
book/fonts/myfont-[..].woff
"#]],
        );
}

// Empty fonts.css should not copy the default fonts.
#[test]
fn empty_fonts_css() {
    BookTest::from_dir("theme/empty_fonts_css")
        .run("build", |cmd| {
            cmd.expect_stderr(str![[r#"
 INFO Book building has started
 INFO Running the html backend
 INFO HTML book written to `[ROOT]/book`

"#]]);
        })
        .check_file_contains("book/index.html", "fonts.css")
        .check_file_list("book/fonts", str![[""]]);
}

// Custom fonts.css file shouldn't copy default fonts.
#[test]
fn custom_fonts_css() {
    BookTest::from_dir("theme/custom_fonts_css")
        .run("build", |cmd| {
            cmd.expect_stderr(str![[r#"
 INFO Book building has started
 INFO Running the html backend
 INFO HTML book written to `[ROOT]/book`

"#]]);
        })
        .check_file_contains("book/index.html", "fonts-[..].css")
        .check_file_list(
            "book/fonts",
            str![[r#"
book/fonts/fonts-[..].css
book/fonts/myfont-[..].woff
"#]],
        );
}