Interpolation into md-strings

[mauro3]

It would be cool, if interpolation into md-strings worked. For example:

result_of_some_calc = 3

md"""
The result of this tricky calculation is $result_of_some_calc
"""

currently produces via Literate.notebook("tmp.jl", execute=true, mdstrings=true)

I think it would be ok and best if interpolation only works with md-strings and not with general comments.

[nluetts]

I was also looking for such an option, similar to what Weave provides with inline bode blocks (https://weavejl.mpastell.com/stable/usage/#inline-code). What you can do now is to use a postprocessing function that replaces the interpolation syntax with the value. However, you cannot directly access the global variables of your script, so you have to store them somewhere and read them back in in the postprocessing functions. I did this with a temporary YAML file. It was clunky at best 😉 Would be great to have a better, build-in solution.

[jebej]

I needed to include contents from a file in order to display the definition of a function, I am using the following preprocessing function:

function displaycode(str)
    regexp = r"# DISPLAYCODE\(\"(?<filename>.*\.jl)\",(?<startline>\d+),(?<endline>\d+)\)"
    repfun = (s) -> begin
        r = match(regexp, s)
        lines = readlines(r[:filename])[parse(Int,r[:startline]):parse(Int,r[:endline])]
        """
        # ```julia
        # $(join(lines, "\n# "))
        # ```
        """
    end
    replace(str, regexp=>repfun)
end

It replaces a line in a markdown chunk like this one (you must specify start and end line numbers to include):

# Here is the function definition:
# DISPLAYCODE("src/yourfile.jl",27,46)