Merge 42548626b3 into 5047103527

Project.toml

@@ -4,6 +4,7 @@ version = "2.15.0"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
+CommonMark = "a80b9123-70ca-4bc0-993e-6e3bcb318db6"
 IOCapture = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"

src/Literate.jl

@@ -6,7 +6,7 @@ https://fredrikekre.github.io/Literate.jl/ for documentation.
 """
 module Literate
 
-import JSON, REPL, IOCapture
+import JSON, REPL, IOCapture, CommonMark
 
 include("IJulia.jl")
 import .IJulia
@@ -16,6 +16,7 @@ struct DefaultFlavor <: AbstractFlavor end
 struct DocumenterFlavor <: AbstractFlavor end
 struct CommonMarkFlavor <: AbstractFlavor end
 struct FranklinFlavor <: AbstractFlavor end
+struct CarpentriesFlavor <: AbstractFlavor end
 
 # # Some simple rules:
 #
@@ -246,7 +247,7 @@ function edit_commit(inputfile, user_config)
             readchomp(
                 pipeline(
                     setenv(`$(git) rev-parse --show-toplevel`; dir=dirname(inputfile));
-                    stderr=devnull,
+                    stderr=devnull
                 )
             )
         catch
@@ -527,6 +528,56 @@ function script(inputfile, outputdir=pwd(); config::AbstractDict=Dict(), kwargs.
 end
 
 
+#_______________________________________________________________________________________
+# Define general functions needed for admonitions formating.
+
+function containsAdmonition(chunk)
+    for line in chunk.lines
+        if startswith(strip(line.first * line.second), "!!!")
+            return true
+        end
+    end
+    return false
+end
+
+function chunkToMD(chunk)
+    parser = CommonMark.Parser()
+    CommonMark.enable!(parser, CommonMark.AdmonitionRule())
+    buffer = IOBuffer()
+    for line in chunk.lines
+        write(buffer, line.first * line.second, '\n')
+    end
+    str = String(take!(buffer))
+    return parser(str)
+end
+
+function rewriteContent!(mdContent)
+    for (node, entering) in mdContent
+        if isa(node.t, CommonMark.Admonition)
+            admonition = node.t
+            node.t = CommonMark.Paragraph()
+            if admonition.category == "yaml"
+                node.first_child.t = CommonMark.Text()
+                node.first_child.nxt.t = CommonMark.Paragraph()
+                CommonMark.insert_after(node.first_child.nxt.last_child, CommonMark.text("\n---\n"))
+                CommonMark.insert_before(node.first_child.nxt, CommonMark.text("---\n"))
+            else
+                CommonMark.insert_before(node, CommonMark.text(""":::::: $(admonition.category)
+
+                ## $(admonition.title)
+
+                """))
+                CommonMark.insert_after(node, CommonMark.text("::::::\n\n"))
+            end
+        end
+    end
+    mdContent
+end
+
+#_______________________________________________________________________________________
+
+
+
 """
     Literate.markdown(inputfile, outputdir=pwd(); config::AbstractDict=Dict(), kwargs...)
 
@@ -540,12 +591,37 @@ function markdown(inputfile, outputdir=pwd(); config::AbstractDict=Dict(), kwarg
     # preprocessing and parsing
     chunks, config =
         preprocessor(inputfile, outputdir; user_config=config, user_kwargs=kwargs, type=:md)
-
     # create the markdown file
-    sb = sandbox()
     iomd = IOBuffer()
+
+
+    write_md_chunks!(iomd, chunks, outputdir, config)
+
+
+    # custom post-processing from user
+    content = config["postprocess"](String(take!(iomd)))
+
+    # write to file
+    outputfile = write_result(content, config)
+    return outputfile
+
+end
+
+function write_md_chunks!(iomd, chunks, outputdir, config)
+    flavor = config["flavor"]
+    sb = sandbox()
     for (chunknum, chunk) in enumerate(chunks)
         if isa(chunk, MDChunk)
+
+            if flavor isa CarpentriesFlavor
+                if containsAdmonition(chunk)
+                    md_chunk = chunkToMD(chunk)
+                    rewriteContent!(md_chunk)
+                    CommonMark.markdown(iomd, md_chunk)
+                    continue
+                end
+            end
+
             for line in chunk.lines
                 write(iomd, line.second, '\n') # skip indent here
             end
@@ -578,21 +654,16 @@ function markdown(inputfile, outputdir=pwd(); config::AbstractDict=Dict(), kwarg
                         fake_source=config["literate_outputfile"],
                         flavor=config["flavor"],
                         image_formats=config["image_formats"],
-                                      file_prefix="$(config["name"])-$(chunknum)",
+                        file_prefix="$(config["name"])-$(chunknum)"
                     )
                 end
             end
         end
         write(iomd, '\n') # add a newline between each chunk
     end
+end
 
-    # custom post-processing from user
-    content = config["postprocess"](String(take!(iomd)))
 
-    # write to file
-    outputfile = write_result(content, config)
-    return outputfile
-end
 
 function execute_markdown!(io::IO, sb::Module, block::String, outputdir;
     inputfile::String, fake_source::String,
@@ -601,7 +672,8 @@ function execute_markdown!(io::IO, sb::Module, block::String, outputdir;
     r, str, _ = execute_block(sb, block; inputfile=inputfile, fake_source=fake_source)
     # issue #101: consecutive codefenced blocks need newline
     # issue #144: quadruple backticks allow for triple backticks in the output
-    plain_fence = "\n````\n" =>  "\n````"
+    plain_fence = "\n````$(flavor == CarpentriesFlavor() ? "output" : "")\n" => "\n````"
+    # Here CarpentiresFlavor fork...
     if r !== nothing && !REPL.ends_with_semicolon(block)
         if (flavor isa FranklinFlavor || flavor isa DocumenterFlavor) &&
            Base.invokelatest(showable, MIME("text/html"), r)