Skip to content

Commit f851777

Browse files
committed
Document pluto_to_pdf
1 parent 37577bb commit f851777

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/PlutoPDF.jl

+13
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,20 @@ function html_to_pdf(html_path::AbstractString, output_path::Union{AbstractStrin
6363
output_path
6464
end
6565

66+
"""
67+
```julia
68+
pluto_to_pdf(notebook_path::String[, output_pdf_path::String];
69+
options=default_options,
70+
open::Bool=true,
71+
console_output::Bool=true,
72+
)
73+
```
74+
75+
Run a notebook, generate an Export HTML and then print it to a PDF file!
6676
77+
# Options
78+
The `options` keyword argument can be a named tuple to configure the PDF export. The possible options can be seen in the [docs for `puppeteer.PDFOptions`](https://pptr.dev/api/puppeteer.pdfoptions).
79+
"""
6780
function pluto_to_pdf(notebook_path::AbstractString, output_path::Union{AbstractString,Nothing}=nothing; kwargs...)
6881
c = Pluto.Configuration.from_flat_kwargs(;
6982
disable_writing_notebook_files = true,

0 commit comments

Comments
 (0)