Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add franklin flavored markdown #147

Closed
wants to merge 1 commit into from
Closed

add franklin flavored markdown #147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion src/Literate.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ module Literate

import JSON, REPL, IOCapture

abstract type Flavor end
struct Franklin <: Flavor end

include("IJulia.jl")
import .IJulia

Expand Down Expand Up @@ -458,7 +461,7 @@ function markdown(inputfile, outputdir=pwd(); config::Dict=Dict(), kwargs...)
write_code = !(all(l -> endswith(l, "#hide"), chunk.lines) && !(config["documenter"]::Bool))
write_code && write(iomd, seekstart(iocode))
if config["execute"]::Bool
execute_markdown!(iomd, sb, join(chunk.lines, '\n'), outputdir)
execute_markdown!(iomd, Franklin(), sb, join(chunk.lines, '\n'), outputdir)
end
end
write(iomd, '\n') # add a newline between each chunk
Expand Down Expand Up @@ -504,6 +507,44 @@ function execute_markdown!(io::IO, sb::Module, block::String, outputdir)
end
end

function execute_markdown!(io::IO, flavor::Franklin, sb::Module, block::String, outputdir)
# TODO: Deal with explicit display(...) calls
r, str, _ = execute_block(sb, block)
plain_fence = "\n```\n" => "\n```" # issue #101: consecutive codefenced blocks need newline
if r !== nothing && !REPL.ends_with_semicolon(block)
for (mime, ext) in [(MIME("image/svg+xml"), ".svg"), (MIME("image/png"), ".png"), (MIME("image/jpeg"), ".jpeg")]
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jkrumbiegel is this fine for svg output or is it better to use something like JuliaDocs/Documenter.jl#1538? I only included text/html in my PR for now.

if showable(mime, r)
file = string(hash(block) % UInt32) * ext
open(joinpath(outputdir, file), "w") do io
Base.invokelatest(show, io, mime, r)
end
write(io, "![](", file, ")\n")
return
end
end
if showable(MIME("text/html"), r)
write(io, "\n~~~\n")
Base.invokelatest(show, io, MIME("text/html"), r)
write(io, "\n~~~\n")
return
end
if showable(MIME("text/markdown"), r)
write(io, '\n')
Base.invokelatest(show, io, MIME("text/markdown"), r)
write(io, '\n')
return
end
# fallback to text/plain
write(io, plain_fence.first)
Base.invokelatest(show, io, "text/plain", r)
write(io, plain_fence.second, '\n')
return
elseif !isempty(str)
write(io, plain_fence.first, str, plain_fence.second, '\n')
return
end
end


const JUPYTER_VERSION = v"4.3.0"

Expand Down