actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add before_body_end handlebars partial 

Add a partial just before the body closing tag to add custom html code.
The use case is for adding javascript snippet that involves more than
just importing external scripts, e.g. web analytics.
This commit is contained in:
Riccardo Magliocchetti 2021-05-12 12:59:08 +02:00
parent 89a2e39b80
commit 6880df3efb
5 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
guide/src/format/theme/README.md
View File

@ -14,6 +14,7 @@ Here are the files you can override:
- **_index.hbs_** is the handlebars template. - **_index.hbs_** is the handlebars template.
- **_head.hbs_** is appended to the HTML `<head>` section. - **_head.hbs_** is appended to the HTML `<head>` section.
- **_header.hbs_** content is appended on top of every book page. - **_header.hbs_** content is appended on top of every book page.
- **_before_body_end.hbs_** content is appended before body closing tag.
- **_css/_** contains the CSS files for styling the book. - **_css/_** contains the CSS files for styling the book.
- **_css/chrome.css_** is for UI elements. - **_css/chrome.css_** is for UI elements.
- **_css/general.css_** is the base styles. - **_css/general.css_** is the base styles.

3
src/renderer/html_handlebars/hbs_renderer.rs
View File

@ -502,6 +502,9 @@ impl Renderer for HtmlHandlebars {
debug!("Register the header handlebars template"); debug!("Register the header handlebars template");
handlebars.register_partial("header", String::from_utf8(theme.header.clone())?)?; handlebars.register_partial("header", String::from_utf8(theme.header.clone())?)?;
debug!("Register the before_body_end handlebars template");
handlebars.register_partial("before_body_end", String::from_utf8(theme.before_body_end.clone())?)?;
debug!("Register handlebars helpers"); debug!("Register handlebars helpers");
self.register_hbs_helpers(&mut handlebars, &html_config); self.register_hbs_helpers(&mut handlebars, &html_config);

1
src/theme/before_body_end.hbs Normal file
View File

@ -0,0 +1 @@
{{!-- Put your before_body_end HTML text here --}}

2
src/theme/index.hbs
View File

@ -308,5 +308,7 @@
{{/if}} {{/if}}
{{/if}} {{/if}}
{{> before_body_end}}
</body> </body>
</html> </html>

6
src/theme/mod.rs
View File

@ -17,6 +17,7 @@ pub static INDEX: &[u8] = include_bytes!("index.hbs");
pub static HEAD: &[u8] = include_bytes!("head.hbs"); pub static HEAD: &[u8] = include_bytes!("head.hbs");
pub static REDIRECT: &[u8] = include_bytes!("redirect.hbs"); pub static REDIRECT: &[u8] = include_bytes!("redirect.hbs");
pub static HEADER: &[u8] = include_bytes!("header.hbs"); pub static HEADER: &[u8] = include_bytes!("header.hbs");
pub static BEFORE_BODY_END: &[u8] = include_bytes!("before_body_end.hbs");
pub static CHROME_CSS: &[u8] = include_bytes!("css/chrome.css"); pub static CHROME_CSS: &[u8] = include_bytes!("css/chrome.css");
pub static GENERAL_CSS: &[u8] = include_bytes!("css/general.css"); pub static GENERAL_CSS: &[u8] = include_bytes!("css/general.css");
pub static PRINT_CSS: &[u8] = include_bytes!("css/print.css"); pub static PRINT_CSS: &[u8] = include_bytes!("css/print.css");
@ -50,6 +51,7 @@ pub struct Theme {
pub head: Vec<u8>, pub head: Vec<u8>,
pub redirect: Vec<u8>, pub redirect: Vec<u8>,
pub header: Vec<u8>, pub header: Vec<u8>,
pub before_body_end: Vec<u8>,
pub chrome_css: Vec<u8>, pub chrome_css: Vec<u8>,
pub general_css: Vec<u8>, pub general_css: Vec<u8>,
pub print_css: Vec<u8>, pub print_css: Vec<u8>,
@ -83,6 +85,7 @@ impl Theme {
(theme_dir.join("head.hbs"), &mut theme.head), (theme_dir.join("head.hbs"), &mut theme.head),
(theme_dir.join("redirect.hbs"), &mut theme.redirect), (theme_dir.join("redirect.hbs"), &mut theme.redirect),
(theme_dir.join("header.hbs"), &mut theme.header), (theme_dir.join("header.hbs"), &mut theme.header),
(theme_dir.join("before_body_end.hbs"), &mut theme.before_body_end),
(theme_dir.join("book.js"), &mut theme.js), (theme_dir.join("book.js"), &mut theme.js),
(theme_dir.join("css/chrome.css"), &mut theme.chrome_css), (theme_dir.join("css/chrome.css"), &mut theme.chrome_css),
(theme_dir.join("css/general.css"), &mut theme.general_css), (theme_dir.join("css/general.css"), &mut theme.general_css),
@ -149,6 +152,7 @@ impl Default for Theme {
head: HEAD.to_owned(), head: HEAD.to_owned(),
redirect: REDIRECT.to_owned(), redirect: REDIRECT.to_owned(),
header: HEADER.to_owned(), header: HEADER.to_owned(),
before_body_end: BEFORE_BODY_END.to_owned(),
chrome_css: CHROME_CSS.to_owned(), chrome_css: CHROME_CSS.to_owned(),
general_css: GENERAL_CSS.to_owned(), general_css: GENERAL_CSS.to_owned(),
print_css: PRINT_CSS.to_owned(), print_css: PRINT_CSS.to_owned(),
@ -206,6 +210,7 @@ mod tests {
"head.hbs", "head.hbs",
"redirect.hbs", "redirect.hbs",
"header.hbs", "header.hbs",
"before_body_end.hbs",
"favicon.png", "favicon.png",
"favicon.svg", "favicon.svg",
"css/chrome.css", "css/chrome.css",
@ -236,6 +241,7 @@ mod tests {
head: Vec::new(), head: Vec::new(),
redirect: Vec::new(), redirect: Vec::new(),
header: Vec::new(), header: Vec::new(),
before_body_end: Vec::new(),
chrome_css: Vec::new(), chrome_css: Vec::new(),
general_css: Vec::new(), general_css: Vec::new(),
print_css: Vec::new(), print_css: Vec::new(),