adding support for mdstring in Literate (#881)

tlienart · Sep 10, 2021 · 12946c3 · 12946c3 · tlienart · Sep 10, 2021
1 parent 9cd419e
commit 12946c3
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 7 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "Franklin"
 uuid = "713c75ef-9fc9-4b05-94a9-213340da978e"
 authors = ["Thibaut Lienart <[email protected]>"]
-version = "0.10.51"
+version = "0.10.52"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

diff --git a/src/eval/literate.jl b/src/eval/literate.jl
@@ -40,13 +40,23 @@ function literate_to_franklin(rpath::AS)::Tuple{String,Bool}
     # don't show Literate's infos
     Logging.disable_logging(Logging.LogLevel(Logging.Info))
     # >> output the markdown
-    Literate.markdown(fpath, outpath;
-                      config=Dict("codefence" => (LITERATE_JULIA_FENCE => "```")),
-                      documenter=false, postprocess=literate_post_process, credit=false)
+    Literate.markdown(
+        fpath, outpath;
+        flavor=Literate.CommonMarkFlavor(),
+        mdstrings=locvar(:literate_mds)::Bool,
+        config=Dict("codefence" => (LITERATE_JULIA_FENCE => "```")),
+        postprocess=literate_post_process,
+        credit=false
+    )
     # >> output the script
-    Literate.script(fpath, outpath; documenter=false,
-                      postprocess=s->(MESSAGE_FILE_GEN_LIT * s),
-                      name=fname * "_script", credit=false)
+    Literate.script(
+        fpath, outpath;
+        flavor=Literate.CommonMarkFlavor(),
+        mdstrings=locvar(:literate_mds)::Bool,
+        postprocess=s->(MESSAGE_FILE_GEN_LIT * s),
+        name=fname * "_script",
+        credit=false
+    )
     # bring back logging
     Logging.disable_logging(Logging.LogLevel(Logging.Debug))
     # see if things have changed

diff --git a/src/utils/vars.jl b/src/utils/vars.jl
@@ -60,6 +60,8 @@ const GLOBAL_VARS_DEFAULT = [
     "fd_rss_feed_url"  => dpair(""),
     # keep track of all anchors {label => page} in case of clash, there's no guarantee
     "anchors"          => dpair(LittleDict{String,String}()),
+    # allow md strings in Literate
+    "literate_mds"     => dpair(false),
     # -----------------------------------------------------
     # LEGACY
     "div_content" => dpair(""), # see build_page