Reference

quarto_format(m::Markdown.Code, eval = false)

Format a block of markdown code to Quarto.

---

quarto_format(m)

Return a plain text from m.

---

quarto_format(m::Markdown.Paragraph)

Return a plain text of m and a line break.

---

quarto_format(m::AbstractString)

Returns m.

---

quarto_format(m::Markdown.Header{1})

Take a level 1 header and write it as a level 3 header.

---

quarto_format(md::Markdown.MD)

Given a markdown block, apply quarto_format to each of its elements and concatenate the resulting string.

---

quarto_format(md::Markdown.Admonition)

Format a Markdown.Admonition into a callout block in Quarto.

---

quarto_yaml( module_name ;output_dir = “site” ,freeze = “auto” ,cache = “true” ,warning = “false” ,comments = “true” ,repo = “USERNAME/REPOSITORY” ,theme = “flatly” )

Generate the _quarto.yaml file.

---

quarto_doc(s::Symbol)

Create the documentation of a symbol (function, object, etc) s.

---

quarto_doc_page(s; dir = “docs/reference”)

Given a symbol s, write its .qmd doc into the folder dir.

---

quarto_doc_short(s::Symbol)

Create a short description of the object. Used to build the Reference page.

---

quarto_build_site(module_name; kwargs…)

Create all the files necessary to build the Quarto website for the first time.

---

quarto_styles()

Create the docs/styles.css file with some suggested css classes.

---

quarto_callout_block(s)

Create a callout block with the string s.

---

quarto_index()

Generate the index.qmd file. It is just a copy of the README.md file.

---

quarto_build_refpage(module_name; output = “docs/reference.qmd”)

Build the docs/reference.qmd file with a short description of each object.

---