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

Try to update handlebars

This commit is contained in:
Matt Ickstadt 2018-07-24 15:52:47 -05:00
parent 49c26a93f2
commit 33f437af9d
3 changed files with 146 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -220,12 +220,7 @@ impl HtmlHandlebars {
}
fn register_hbs_helpers(&self, handlebars: &mut Handlebars, html_config: &HtmlConfig) {
handlebars.register_helper(
"toc",
Box::new(helpers::toc::RenderToc {
no_section_label: html_config.no_section_label,
}),
);
handlebars.register_helper("toc", Box::new(helpers::toc::toc));
handlebars.register_helper("previous", Box::new(helpers::navigation::previous));
handlebars.register_helper("next", Box::new(helpers::navigation::next));
}
@ -402,12 +397,12 @@ fn make_data(
json!(config.book.description.clone().unwrap_or_default()),
);
data.insert("favicon".to_owned(), json!("favicon.png"));
if let Some(ref livereload) = html_config.livereload_url {
data.insert("livereload".to_owned(), json!(livereload));
}
// Add google analytics tag
if let Some(ref ga) = config.html_config().and_then(|html| html.google_analytics) {
if let Some(ref ga) = html.google_analytics {
data.insert("google_analytics".to_owned(), json!(ga));
}
@ -415,6 +410,10 @@ fn make_data(
data.insert("mathjax_support".to_owned(), json!(true));
}
if html.no_section_label {
data.insert("no_section_label".to_owned(), json!(true));
}
// Add check to see if there is an additional style
if !html.additional_css.is_empty() {
let mut css = Vec::new();

51
src/renderer/html_handlebars/helpers/navigation.rs
View File

@ -1,7 +1,7 @@
use std::collections::BTreeMap;
use std::path::Path;
use handlebars::{Context, Handlebars, Helper, RenderContext, RenderError, Renderable};
use handlebars::{Context, Handlebars, Helper, RenderContext, RenderError, Renderable, HelperResult, Output};
use serde_json;
use utils;
@ -45,15 +45,15 @@ impl Target {
}
}
fn find_chapter(rc: &mut RenderContext, target: Target) -> Result<Option<StringMap>, RenderError> {
fn find_chapter(cx: &Context, rc: &mut RenderContext, target: Target) -> Result<Option<StringMap>, RenderError> {
debug!("Get data from context");
let chapters = rc.evaluate_absolute("chapters", true).and_then(|c| {
let chapters = rc.evaluate_absolute(cx, "chapters", true).and_then(|c| {
serde_json::value::from_value::<Vec<StringMap>>(c.clone())
.map_err(|_| RenderError::new("Could not decode the JSON data"))
})?;
let base_path = rc.evaluate_absolute("path", true)?
let base_path = rc.evaluate_absolute(cx, "path", true)?
.as_str()
.ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
.replace("\"", "");
@ -80,16 +80,17 @@ fn find_chapter(rc: &mut RenderContext, target: Target) -> Result<Option<StringM
Ok(None)
}
fn render(
_h: &Helper,
r: &Handlebars,
rc: &mut RenderContext,
chapter: &StringMap,
) -> Result<(), RenderError> {
fn render<'h: 'rc, 'rc>(
h: &'h Handlebars,
cx: &'rc Context,
rc: &'rc mut RenderContext<'h>,
out: &mut Output,
chapter: StringMap,
) -> HelperResult {
trace!("Creating BTreeMap to inject in context");
let mut context = BTreeMap::new();
let base_path = rc.evaluate_absolute("path", false)?
let base_path = rc.evaluate_absolute(cx, "path", false)?
.as_str()
.ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
.replace("\"", "");
@ -117,31 +118,41 @@ fn render(
trace!("Render template");
_h.template()
h.render_template()
.ok_or_else(|| RenderError::new("Error with the handlebars template"))
.and_then(|t| {
let mut local_rc = rc.with_context(Context::wraps(&context)?);
t.render(r, &mut local_rc)
let local_cx = Context::wraps(&context)?;
t.render(r, &local_cx, rc, out)
})?;
Ok(())
}
pub fn previous(_h: &Helper, r: &Handlebars, rc: &mut RenderContext) -> Result<(), RenderError> {
pub fn previous<'h: 'rc, 'rc>(
h: &'h Handlebars,
cx: &'rc Context,
rc: &'rc mut RenderContext<'h>,
out: &mut Output
) -> HelperResult {
trace!("previous (handlebars helper)");
if let Some(previous) = find_chapter(rc, Target::Previous)? {
render(_h, r, rc, &previous)?;
if let Some(previous) = find_chapter(cx, rc, Target::Previous)? {
render(h, cx, rc, out, &previous)?;
}
Ok(())
}
pub fn next(_h: &Helper, r: &Handlebars, rc: &mut RenderContext) -> Result<(), RenderError> {
pub fn next<'h: 'rc, 'rc>(
h: &'h Handlebars,
cx: &'rc Context,
rc: &'rc mut RenderContext<'h>,
out: &mut Output
) -> HelperResult {
trace!("next (handlebars helper)");
if let Some(next) = find_chapter(rc, Target::Next)? {
render(_h, r, rc, &next)?;
if let Some(next) = find_chapter(cx, rc, Target::Next)? {
render(h, cx, rc, out, &next)?;
}
Ok(())

224
src/renderer/html_handlebars/helpers/toc.rs
View File

@ -3,142 +3,134 @@ use std::path::Path;
use utils;
use handlebars::{Handlebars, Helper, HelperDef, RenderContext, RenderError};
use handlebars::{Helper, Handlebars, Context, RenderContext, Output, HelperResult, RenderError};
use pulldown_cmark::{html, Event, Parser, Tag};
use serde_json;
// Handlebars helper to construct TOC
#[derive(Clone, Copy)]
pub struct RenderToc {
pub no_section_label: bool,
}
pub fn toc(h: &Helper, _: &Handlebars, cx: &Context, rc: &mut RenderContext, out: &mut Output) -> HelperResult {
// get value from context data
// rc.get_path() is current json parent path, you should always use it like this
// param is the key of value you want to display
let chapters = rc.evaluate_absolute(cx, "chapters", true).and_then(|c| {
serde_json::value::from_value::<Vec<BTreeMap<String, String>>>(c.clone())
.map_err(|_| RenderError::new("Could not decode the JSON data"))
})?;
let current = rc.evaluate_absolute(cx, "path", true)?
.as_str()
.ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
.replace("\"", "");
let no_section_label = rc.evaluate_absolute(cx, "no_section_label", true)?.as_bool().unwrap_or(false);
impl HelperDef for RenderToc {
fn call(&self, _h: &Helper, _: &Handlebars, rc: &mut RenderContext) -> Result<(), RenderError> {
// get value from context data
// rc.get_path() is current json parent path, you should always use it like this
// param is the key of value you want to display
let chapters = rc.evaluate_absolute("chapters", true).and_then(|c| {
serde_json::value::from_value::<Vec<BTreeMap<String, String>>>(c.clone())
.map_err(|_| RenderError::new("Could not decode the JSON data"))
})?;
let current = rc.evaluate_absolute("path", true)?
.as_str()
.ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
.replace("\"", "");
out.write("<ol class=\"chapter\">")?;
rc.writer.write_all(b"<ol class=\"chapter\">")?;
let mut current_level = 1;
let mut current_level = 1;
for item in chapters {
// Spacer
if item.get("spacer").is_some() {
out.write("<li class=\"spacer\"></li>")?;
continue;
}
for item in chapters {
// Spacer
if item.get("spacer").is_some() {
rc.writer.write_all(b"<li class=\"spacer\"></li>")?;
continue;
let level = if let Some(s) = item.get("section") {
s.matches('.').count()
} else {
1
};
if level > current_level {
while level > current_level {
out.write("<li>")?;
out.write("<ol class=\"section\">")?;
current_level += 1;
}
let level = if let Some(s) = item.get("section") {
s.matches('.').count()
} else {
1
};
if level > current_level {
while level > current_level {
rc.writer.write_all(b"<li>")?;
rc.writer.write_all(b"<ol class=\"section\">")?;
current_level += 1;
}
rc.writer.write_all(b"<li>")?;
} else if level < current_level {
while level < current_level {
rc.writer.write_all(b"</ol>")?;
rc.writer.write_all(b"</li>")?;
current_level -= 1;
}
rc.writer.write_all(b"<li>")?;
} else {
rc.writer.write_all(b"<li")?;
if item.get("section").is_none() {
rc.writer.write_all(b" class=\"affix\"")?;
}
rc.writer.write_all(b">")?;
out.write("<li>")?;
} else if level < current_level {
while level < current_level {
out.write("</ol>")?;
out.write("</li>")?;
current_level -= 1;
}
out.write("<li>")?;
} else {
out.write("<li")?;
if item.get("section").is_none() {
out.write(" class=\"affix\"")?;
}
out.write(">")?;
}
// Link
let path_exists = if let Some(path) = item.get("path") {
if !path.is_empty() {
rc.writer.write_all(b"<a href=\"")?;
// Link
let path_exists = if let Some(path) = item.get("path") {
if !path.is_empty() {
out.write("<a href=\"")?;
let tmp = Path::new(item.get("path").expect("Error: path should be Some(_)"))
.with_extension("html")
.to_str()
.unwrap()
// Hack for windows who tends to use `\` as separator instead of `/`
.replace("\\", "/");
let tmp = Path::new(item.get("path").expect("Error: path should be Some(_)"))
.with_extension("html")
.to_str()
.unwrap()
// Hack for windows who tends to use `\` as separator instead of `/`
.replace("\\", "/");
// Add link
rc.writer
.write_all(&utils::fs::path_to_root(&current).as_bytes())?;
rc.writer.write_all(tmp.as_bytes())?;
rc.writer.write_all(b"\"")?;
// Add link
out.write(&utils::fs::path_to_root(&current))?;
out.write(&tmp)?;
out.write("\"")?;
if path == &current {
rc.writer.write_all(b" class=\"active\"")?;
}
rc.writer.write_all(b">")?;
true
} else {
false
if path == &current {
out.write(" class=\"active\"")?;
}
out.write(">")?;
true
} else {
false
};
if !self.no_section_label {
// Section does not necessarily exist
if let Some(section) = item.get("section") {
rc.writer.write_all(b"<strong aria-hidden=\"true\">")?;
rc.writer.write_all(section.as_bytes())?;
rc.writer.write_all(b"</strong> ")?;
}
}
} else {
false
};
if let Some(name) = item.get("name") {
// Render only inline code blocks
// filter all events that are not inline code blocks
let parser = Parser::new(name).filter(|event| match *event {
Event::Start(Tag::Code)
| Event::End(Tag::Code)
| Event::InlineHtml(_)
| Event::Text(_) => true,
_ => false,
});
// render markdown to html
let mut markdown_parsed_name = String::with_capacity(name.len() * 3 / 2);
html::push_html(&mut markdown_parsed_name, parser);
// write to the handlebars template
rc.writer.write_all(markdown_parsed_name.as_bytes())?;
if no_section_label {
// Section does not necessarily exist
if let Some(section) = item.get("section") {
out.write("<strong aria-hidden=\"true\">")?;
out.write(section)?;
out.write("</strong> ")?;
}
if path_exists {
rc.writer.write_all(b"</a>")?;
}
rc.writer.write_all(b"</li>")?;
}
while current_level > 1 {
rc.writer.write_all(b"</ol>")?;
rc.writer.write_all(b"</li>")?;
current_level -= 1;
}
rc.writer.write_all(b"</ol>")?;
Ok(())
if let Some(name) = item.get("name") {
// Render only inline code blocks
// filter all events that are not inline code blocks
let parser = Parser::new(name).filter(|event| match *event {
Event::Start(Tag::Code)
| Event::End(Tag::Code)
| Event::InlineHtml(_)
| Event::Text(_) => true,
_ => false,
});
// render markdown to html
let mut markdown_parsed_name = String::with_capacity(name.len() * 3 / 2);
html::push_html(&mut markdown_parsed_name, parser);
// write to the handlebars template
out.write(&markdown_parsed_name)?;
}
if path_exists {
out.write("</a>")?;
}
out.write("</li>")?;
}
while current_level > 1 {
out.write("</ol>")?;
out.write("</li>")?;
current_level -= 1;
}
out.write("</ol>")?;
Ok(())
}