Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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");
Expand All @@ -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)
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion src/build.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
4 changes: 2 additions & 2 deletions src/module_doc.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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"];
Expand All @@ -14,7 +14,7 @@ let

and to build all notebooks, use:

```
```julia-repl
julia> build_notebooks(BuildOptions(dir))
```

Expand Down
2 changes: 1 addition & 1 deletion src/output.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```
Expand Down