jwebsite/menu1.md

@def title = "Code blocks" @def hascode = true @def date = Date(2019, 3, 22) @def rss = "A short description of the page which would serve as blurb in a RSS feed; you can use basic markdown here but the whole description string must be a single line (not a multiline string). Like this one for instance. Keep in mind that styling is minimal in RSS so for instance don't expect maths or fancy styling to work; images should be ok though: "

@def tags = ["syntax", "code"]

Working with code blocks

\toc

Live evaluation of code blocks

If you would like to show code as well as what the code outputs, you only need to specify where the script corresponding to the code block will be saved.

Indeed, what happens is that the code block gets saved as a script which then gets executed. This also allows for that block to not be re-executed every time you change something else on the page.

Here's a simple example (change values in a to see the results being live updated):

using LinearAlgebra
a = [1, 2, 3, 3, 4, 5, 2, 2]
@show dot(a, a)
println(dot(a, a))

You can now show what this would look like:

\output{./exdot.jl}

Notes:

• you don't have to specify the .jl (see below),
• you do need to explicitly use print statements or @show for things to show, so just leaving a variable at the end like you would in the REPL will show nothing,
• only Julia code blocks are supported at the moment, there may be a support for scripting languages like R or python in the future,
• the way you specify the path is important; see the docs for more info. If you don't care about how things are structured in your /assets/ folder, just use ./scriptname.jl. If you want things to be grouped, use ./group/scriptname.jl. For more involved uses, see the docs.

Lastly, it's important to realise that if you don't change the content of the code, then that code will only be executed once even if you make multiple changes to the text around it.

Here's another example,

for i ∈ 1:5, j ∈ 1:5
    print(" ", rpad("*"^i,5), lpad("*"^(6-i),5), j==5 ? "\n" : " "^4)
end

which gives the (utterly useless):

\output{./code/ex2}

note the absence of .jl, it's inferred.

You can also hide lines (that will be executed nonetheless):

using Random
Random.seed!(1) # hide
@show randn(2)

\output{./code/ex3}

Including scripts

Another approach is to include the content of a script that has already been executed. This can be an alternative to the description above if you'd like to only run the code once because it's particularly slow or because it's not Julia code. For this you can use the \input command specifying which language it should be tagged as:

\input{julia}{/_assets/scripts/script1.jl}

these scripts can be run in such a way that their output is also saved to file, see scripts/generate_results.jl for instance, and you can then also input the results:

\output{/_assets/scripts/script1.jl}

which is convenient if you're presenting code.

Note: paths specification matters, see the docs for details.

Using this approach with the generate_results.jl file also makes sure that all the code on your website works and that all results match the code which makes maintenance easier.