`quarto.format`

`ParseFormatResult`

`format_identifier`

function quarto.format.format_identifier()

Returns a table with the format identifier information, including: - target-format: The full target format name, e.g. html+variant - base-format: The base format name, e.g. html - display-name: A human-readable display name for the format, e.g. HTML - extension: The name of the extension that exposes the format, if present

`is_asciidoc_output`

function quarto.format.is_asciidoc_output()
  -> string

Return true if format is asciidoc or asciidoctor.

`is_ast_output`

function quarto.format.is_ast_output()
  -> string

Return true if format is json or native.

`is_beamer_output`

function quarto.format.is_beamer_output()
  -> string

Return true if format is beamer.

`is_bibliography_output`

function quarto.format.is_bibliography_output()
  -> string

Return true if format is bib.

`is_confluence_output`

function quarto.format.is_confluence_output()
  -> string

Return true if format is confluence-xml.

`is_dashboard_output`

function quarto.format.is_dashboard_output()
  -> string

Return true if format is dashboard.

`is_docusaurus_output`

function quarto.format.is_docusaurus_output()
  -> string

Return true if format is docusaurus-md.

`is_docx_output`

function quarto.format.is_docx_output()
  -> string

Return true if format is docx.

`is_email_output`

function quarto.format.is_email_output()
  -> string

Return true if format is email.

`is_epub_output`

function quarto.format.is_epub_output()
  -> string

Return true if format is epub.

`is_format`

function quarto.format.is_format(name: string)
  -> boolean

Detect if the current format matches name

The name parameter can match an exact Pandoc format name (e.g. docx, latex, etc. or can match based on an alias that groups commonly targeted formats together. Aliases include:

latex: latex, pdf
pdf: latex, pdf
epub: epub*
html: html*, epub*, revealjs
html:js: html*, revealjs
markdown: markdown*, commonmark*, gfm, markua

Note that the html:js alias indicates that the target format is capable of executing JavaScript (this maps to all HTML formats save for ePub).

`is_github_markdown_output`

function quarto.format.is_github_markdown_output()
  -> string

Return true if format is gfm.

`is_html_output`

function quarto.format.is_html_output()
  -> string

Return true if format is an html-derived output format.

`is_html_slide_output`

function quarto.format.is_html_slide_output()
  -> string

Return true if format is revealjs, s5, dzslides, slidy, slideous, or revealjs.

`is_hugo_markdown_output`

function quarto.format.is_hugo_markdown_output()
  -> string

Return true if format is hugo-md.

`is_ipynb_output`

function quarto.format.is_ipynb_output()
  -> string

Return true if format is ipynb.

`is_jats_output`

function quarto.format.is_jats_output()
  -> string

Return true if format is jats.

`is_json_output`

function quarto.format.is_json_output()
  -> string

Return true if format is json.

`is_latex_output`

function quarto.format.is_latex_output()
  -> string

Return true if format is a latex-derived output format.

`is_markdown_output`

function quarto.format.is_markdown_output()
  -> string

Return true if format is a markdown-derived output format.

`is_markdown_with_html_output`

function quarto.format.is_markdown_with_html_output()
  -> string

Return true if format is a markdown-derived output format that supports HTML code.

`is_native_output`

function quarto.format.is_native_output()
  -> string

Return true if format is native.

`is_odt_output`

function quarto.format.is_odt_output()
  -> string

Return true if format is odt.

`is_powerpoint_output`

function quarto.format.is_powerpoint_output()
  -> string

Return true if format is pptx.

`is_raw`

function quarto.format.is_raw(el: boolean|pandoc.Block|pandoc.BlockQuote|pandoc.Blocks|pandoc.BulletList...(+39))
  -> boolean

Return true if el is a RawInline or RawBlock Pandoc node.

`is_raw_html`

function quarto.format.is_raw_html(rawEl: boolean|pandoc.Block|pandoc.BlockQuote|pandoc.Blocks|pandoc.BulletList...(+39))
  -> boolean

Return true if rawEl is a RawInline or RawBlock of format html

`is_revealjs_output`

function quarto.format.is_revealjs_output()
  -> string

Return true if format is revealjs.

`is_rtf_output`

function quarto.format.is_rtf_output()
  -> string

Return true if format is rtf.

`is_slide_output`

function quarto.format.is_slide_output()
  -> string

Return true if format is beamer, revealjs, s5, dzslides, slidy, slideous, revealjs or pptx.

`is_typst_output`

function quarto.format.is_typst_output()
  -> string

Return true if format is typst.

`is_word_processor_output`

function quarto.format.is_word_processor_output()
  -> string

Return true if format is docx or odt.

`parse_format`

function quarto.format.parse_format(raw_format: string)
  -> quarto.format.ParseFormatResult

Returns an object with the format name and variants as would be interpreted by Pandoc

`typst`

table