Allow LaTeX in standalone markdown files via --markdown-enable-math.

huonw · huonw · commit 208818438bfc · 2014-09-29T22:00:36.000+10:00
Requires the KaTeX files to be arranged correctly.
diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs
@@ -253,8 +253,6 @@ pub fn run(mut krate: clean::Crate, external_html: &ExternalHtml, dst: Path) ->
         render_redirect_pages: false,
     };
 
-    markdown::enable_math.replace(None);
-
     try!(mkdir(&cx.dst));
 
     // Crawl the crate, building a summary of the stability levels.  NOTE: this
diff --git a/src/librustdoc/lib.rs b/src/librustdoc/lib.rs
@@ -174,7 +174,9 @@ pub fn opts() -> Vec<getopts::OptGroup> {
                  "FILES"),
         optopt("", "markdown-playground-url",
                "URL to send code snippets to", "URL"),
-        optflag("", "markdown-no-toc", "don't include table of contents")
+        optflag("", "markdown-no-toc", "don't include table of contents"),
+        optflag("", "markdown-enable-math",
+                "render LaTeX expressions surrounded by `$$` via the KaTeX javascript library."),
     )
 }
 
@@ -265,7 +267,8 @@ pub fn main_args(args: &[String]) -> int {
         }
         (false, true) => return markdown::render(input, output.unwrap_or(Path::new("doc")),
                                                  &matches, &external_html,
-                                                 !matches.opt_present("markdown-no-toc")),
+                                                 !matches.opt_present("markdown-no-toc"),
+                                                 matches.opt_present("markdown-enable-math")),
         (false, false) => {}
     }
 
diff --git a/src/librustdoc/markdown.rs b/src/librustdoc/markdown.rs
@@ -41,7 +41,9 @@ fn extract_leading_metadata<'a>(s: &'a str) -> (Vec<&'a str>, &'a str) {
 /// Render `input` (e.g. "foo.md") into an HTML file in `output`
 /// (e.g. output = "bar" => "bar/foo.html").
 pub fn render(input: &str, mut output: Path, matches: &getopts::Matches,
-              external_html: &ExternalHtml, include_toc: bool) -> int {
+              external_html: &ExternalHtml,
+              include_toc: bool,
+              enable_math: bool) -> int {
     let input_p = Path::new(input);
     output.push(input_p.filestem().unwrap());
     output.set_extension("html");
@@ -79,12 +81,18 @@ pub fn render(input: &str, mut output: Path, matches: &getopts::Matches,
 
     reset_headers();
 
+    if enable_math {
+        markdown::enable_math.replace(Some(true));
+    }
+
     let rendered = if include_toc {
         format!("{}", MarkdownWithToc(text))
     } else {
         format!("{}", Markdown(text))
     };
 
+    let saw_math = enable_math && markdown::math_seen.get().map_or(false, |x| *x);
+
     let err = write!(
         &mut out,
         r#"<!DOCTYPE html>
@@ -95,6 +103,7 @@ pub fn render(input: &str, mut output: Path, matches: &getopts::Matches,
     <title>{title}</title>
 
     {css}
+    {math_css}
     {in_header}
 </head>
 <body class="rustdoc">
@@ -112,6 +121,7 @@ pub fn render(input: &str, mut output: Path, matches: &getopts::Matches,
         window.playgroundUrl = "{playground}";
     </script>
     {after_content}
+    {math_js}
 </body>
 </html>"#,
         title = Escape(title),
@@ -121,6 +131,26 @@ pub fn render(input: &str, mut output: Path, matches: &getopts::Matches,
         text = rendered,
         after_content = external_html.after_content,
         playground = playground,
+
+        math_css = if saw_math {
+            "<link rel=\"stylesheet\" type=\"text/css\" href=\"katex/katex.min.css\">
+<style>.math-display { text-align: center; }</style>"
+        } else {
+            ""
+        },
+        math_js = if saw_math {
+            r#"<script src="katex/katex.min.js"></script>
+<script type="text/javascript">
+var elements = document.getElementsByClassName("latex-math");
+for (var i = 0; i < elements.length; i++) {
+   var e = elements[i];
+   var style = e.tagName == "P" ? "display" : "text";
+   katex.render("\\" + style + "style " + e.textContent, e);
+}
+</script>"#
+        } else {
+            ""
+        }
         );
 
     match err {

Original file line number	Diff line number	Diff line change
`@@ -174,7 +174,9 @@ pub fn opts() -> Vec<getopts::OptGroup> {`
`174`	`174`	`"FILES"),`
`175`	`175`	`optopt("", "markdown-playground-url",`
`176`	`176`	`"URL to send code snippets to", "URL"),`
`177`		`- optflag("", "markdown-no-toc", "don't include table of contents")`
	`177`	`+ optflag("", "markdown-no-toc", "don't include table of contents"),`
	`178`	`+ optflag("", "markdown-enable-math",`
	`179`	+ "render LaTeX expressions surrounded by `$$` via the KaTeX javascript library."),
`178`	`180`	`)`
`179`	`181`	`}`
`180`	`182`
`@@ -265,7 +267,8 @@ pub fn main_args(args: &[String]) -> int {`
`265`	`267`	`}`
`266`	`268`	`(false, true) => return markdown::render(input, output.unwrap_or(Path::new("doc")),`
`267`	`269`	`&matches, &external_html,`
`268`		`- !matches.opt_present("markdown-no-toc")),`
	`270`	`+ !matches.opt_present("markdown-no-toc"),`
	`271`	`+ matches.opt_present("markdown-enable-math")),`
`269`	`272`	`(false, false) => {}`
`270`	`273`	`}`
`271`	`274`