diff --git a/docs/src/index.md b/docs/src/index.md index 3cde63b..ded41eb 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -103,7 +103,7 @@ Also, it can use [Caching](@ref) to speed up the build even more. To use it, pass a `dir` to write HTML files for all notebook files (the files are recognized by the ".jl" extension and that the file starts with `### A Pluto.jl notebook ###`): -```julia +```julia-repl julia> using PlutoStaticHTML: build_notebooks julia> dir = joinpath("posts", "notebooks"); @@ -116,7 +116,7 @@ julia> build_notebooks(bopts); To run only specific notebooks, specify the `files`: -```julia +```julia-repl julia> files = ["notebook1.jl", "notebook2.jl"]; julia> build_notebooks(bopts, files) @@ -127,7 +127,7 @@ In CI, be sure to call this before using Franklin `serve` or `optimize`. For more options, such as `append_build_context` to add Julia and packages version information, you can pass [`OutputOptions`](@ref): -```julia +```julia-repl julia> oopts = OutputOptions(; append_build_context=true); julia> build_notebooks(bopts, files, oopts) diff --git a/src/build.jl b/src/build.jl index fd7f4df..cac45cc 100644 --- a/src/build.jl +++ b/src/build.jl @@ -459,7 +459,7 @@ Here, `files` is optional. When not passing `files`, then all Pluto notebooks in `dir` will be built. # Example -``` +```julia-repl julia> dir = joinpath(homedir(), "my_project", "notebooks"); julia> bopts = BuildOptions(dir); diff --git a/src/module_doc.jl b/src/module_doc.jl index 05e2c59..20020ac 100644 --- a/src/module_doc.jl +++ b/src/module_doc.jl @@ -4,7 +4,7 @@ let To quickly build two notebooks (evaluate all the code and convert the output to HTML), use: - ``` + ```julia-repl julia> dir = joinpath("posts", "notebooks"); julia> files = ["notebook1.jl", "notebook2.jl"]; @@ -14,7 +14,7 @@ let and to build all notebooks, use: - ``` + ```julia-repl julia> build_notebooks(BuildOptions(dir)) ``` diff --git a/src/output.jl b/src/output.jl index 0f04cd5..9dc72fb 100644 --- a/src/output.jl +++ b/src/output.jl @@ -74,7 +74,7 @@ Arguments: This avoids inconsistent appearance of code blocks on web pages. - `convert_admonitions`: Convert admonitions such as - ``` + ```markdown !!! note This is a note. ```