Add Typst (.Rtyp) input format support (#2429)

Copilot · yihui · web-flow · commit be404d230c8e · 2026-03-22T12:06:29.000-05:00
Co-authored-by: copilot-swe-agent[bot] &lt;198982749+Copilot@users.noreply.github.com&gt;
Co-authored-by: yihui &lt;163582+yihui@users.noreply.github.com&gt;
Co-authored-by: Yihui Xie &lt;xie@yihui.name&gt;
diff --git a/.github/workflows/knitr-examples.yaml b/.github/workflows/knitr-examples.yaml
@@ -92,9 +92,8 @@ jobs:
         shell: bash
 
       - uses: actions/upload-artifact@v4
-        if: failure()
         with:
           name: knitr-examples
           path:
-            knitr-examples/[0-9][0-9][0-9]-*.*
+            knitr-examples/*
           retention-days: 7
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,5 @@ knitr-spin.html
 /inst/examples/*.tex
 /inst/examples/*.sty
 .*.Rnb.cached
+*.Rcheck/
+*.tar.gz
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -181,6 +181,7 @@ Collate:
     'hooks-md.R'
     'hooks-rst.R'
     'hooks-textile.R'
+    'hooks-typst.R'
     'hooks.R'
     'otel.R'
     'output.R'
diff --git a/NAMESPACE b/NAMESPACE
@@ -49,6 +49,7 @@ export(hook_plot_md)
 export(hook_plot_rst)
 export(hook_plot_tex)
 export(hook_plot_textile)
+export(hook_plot_typst)
 export(hook_pngquant)
 export(hook_purl)
 export(hook_r2swf)
@@ -62,6 +63,7 @@ export(hooks_markdown)
 export(hooks_rst)
 export(hooks_sweave)
 export(hooks_textile)
+export(hooks_typst)
 export(image_uri)
 export(imgur_upload)
 export(include_app)
@@ -115,6 +117,7 @@ export(pat_rnw)
 export(pat_rst)
 export(pat_tex)
 export(pat_textile)
+export(pat_typst)
 export(plot_crop)
 export(purl)
 export(rand_seed)
@@ -133,6 +136,7 @@ export(render_markdown)
 export(render_rst)
 export(render_sweave)
 export(render_textile)
+export(render_typst)
 export(restore_raw_output)
 export(rnw2pdf)
 export(rocco)
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,9 @@
 # CHANGES IN knitr VERSION 1.52
 
+## NEW FEATURES
+
+- Added support for a new input format `.Rtyp` for the [Typst](https://typst.app) typesetting system (thanks, @blset #2401, @aksigkvgithub #2283). You can use code chunks and inline R expressions in `.Rtyp` files, knit them via `knitr::knit()` to `.typ` output, or compile to PDF directly via `knit2pdf('input.Rtyp')`. See https://github.com/yihui/knitr-examples/blob/master/128-minimal.Rtyp for a minimal example.
+
 ## BUG FIXES
 
 - The `alt` attribute of figure images now has HTML tags stripped (via `xfun::strip_html()`) and is properly escaped for use in HTML attributes (via `xfun::html_escape(attr = TRUE)`). Previously, HTML in `fig.cap` (e.g., a link) could appear verbatim in `alt`, and double quotes in captions could break the `alt` attribute value (thanks, @cderv, #2004).
diff --git a/R/hooks-typst.R b/R/hooks-typst.R
@@ -0,0 +1,59 @@
+#' @rdname hook_plot
+#' @export
+hook_plot_typst = function(x, options) {
+  if (options$fig.show == 'animate') return(hook_plot_html(x, options))
+
+  cap = .img.cap(options)
+
+  w = options[['out.width']]
+  h = options[['out.height']]
+  s = options[['out.extra']]
+
+  # build named arguments for #image()
+  args = c(
+    if (!is.null(w)) sprintf('width: %s', w),
+    if (!is.null(h)) sprintf('height: %s', h),
+    s
+  )
+  img_path = paste0(opts_knit$get('base.url'), .upload.url(x))
+  img_args = paste(c(sprintf('"%s"', img_path), args), collapse = ', ')
+
+  if (nzchar(cap)) {
+    sprintf('\n#figure(\n  image(%s),\n  caption: [%s],\n)\n', img_args, cap)
+  } else {
+    sprintf('\n#image(%s)\n', img_args)
+  }
+}
+
+#' @rdname output_hooks
+#' @export
+render_typst = function() {
+  opts_chunk$set(dev = 'pdf')
+  opts_knit$set(out.format = 'typst')
+  knit_hooks$set(hooks_typst())
+}
+
+#' @rdname output_hooks
+#' @export
+hooks_typst = function() {
+  hook.source = function(x, options) {
+    x = one_string(c(hilight_source(x, 'markdown', options), ''))
+    lang = tolower(options$lang %n% eng2lang(options$engine))
+    sprintf('\n```%s\n%s```\n', lang, x)
+  }
+  hook.text = function(x, options) {
+    sprintf('\n```\n%s```\n', x)
+  }
+  list(
+    source = hook.source,
+    output = function(x, options) {
+      if (output_asis(x, options)) return(x)
+      hook.text(x, options)
+    },
+    warning = hook.text,
+    message = hook.text,
+    error = hook.text,
+    plot = hook_plot_typst,
+    inline = function(x) .inline.hook(format_sci(x, 'typst'))
+  )
+}
diff --git a/R/output.R b/R/output.R
@@ -221,7 +221,8 @@ knit = function(
       remind_sweave(if (in.file) input, sweave_lines)
     opts_knit$set(out.format = switch(
       pattern, rnw = 'latex', tex = 'latex', html = 'html', md = 'markdown',
-      rst = 'rst', brew = 'brew', asciidoc = 'asciidoc', textile = 'textile'
+      rst = 'rst', brew = 'brew', asciidoc = 'asciidoc', textile = 'textile',
+      typst = 'typst'
     ))
   }
 
@@ -370,7 +371,7 @@ auto_out_name = function(input, ext = tolower(file_ext(input))) {
   base = sans_ext(input)
   name = if (opts_knit$get('tangle')) c(base, '.R') else
     if (ext %in% c('rnw', 'snw')) c(base, '.tex') else
-      if (ext %in% c('rmd', 'rmarkdown', 'qmd', 'rhtml', 'rhtm', 'rtex', 'stex', 'rrst', 'rtextile'))
+      if (ext %in% c('rmd', 'rmarkdown', 'qmd', 'rhtml', 'rhtm', 'rtex', 'stex', 'rrst', 'rtextile', 'rtyp'))
         c(base, '.', substring(ext, 2L)) else
           if (grepl('_knit_', input)) sub('_knit_', '', input) else
             if (ext != 'txt') c(base, '.txt') else c(base, '-out.', ext)
@@ -382,7 +383,8 @@ ext2fmt = c(
   rnw = 'latex', snw = 'latex', tex = 'latex', rtex = 'latex', stex = 'latex',
   htm = 'html', html = 'html', rhtml = 'html', rhtm = 'html',
   md = 'markdown', markdown = 'markdown', rmd = 'markdown', rmarkdown = 'markdown',
-  qmd = 'markdown', brew = 'brew', rst = 'rst', rrst = 'rst'
+  qmd = 'markdown', brew = 'brew', rst = 'rst', rrst = 'rst',
+  rtyp = 'typst'
 )
 
 auto_format = function(ext) {
diff --git a/R/pattern.R b/R/pattern.R
@@ -50,7 +50,13 @@ all_patterns = list(
     chunk.end = '^###[.]\\s+end[.]rcode\\s*$',
     ref.chunk = '^\\s*<<(.+)>>\\s*$',
     inline.code = '@r +([^@]+)\\s*@',
-    inline.comment = '^###[.].*')
+    inline.comment = '^###[.].*'),
+
+  `typst` = list(
+    chunk.begin = '^[\t >]*```+\\s*\\{([a-zA-Z0-9_]+( *[ ,].*)?)\\}\\s*$',
+    chunk.end = '^[\t >]*```+\\s*$',
+    ref.chunk = '^\\s*<<(.+)>>\\s*$',
+    inline.code = '(?<!(^``))(?<!(\n``))`r[ #]([^`]+)\\s*`')
 )
 
 .sep.label = '^(#|--)+\\s*(@knitr|----+)(.*?)-*\\s*$'  # pattern for code chunks in an R script
@@ -109,7 +115,7 @@ set_pattern = function(type) {
 #' @rdname pat_fun
 #' @return The patterns object \code{\link{knit_patterns}} is modified as a side
 #'   effect.
-#' @export pat_rnw pat_brew pat_tex pat_html pat_md pat_rst pat_asciidoc pat_textile
+#' @export pat_rnw pat_brew pat_tex pat_html pat_md pat_rst pat_asciidoc pat_textile pat_typst
 #' @examples # see how knit_patterns is modified
 #' knit_patterns$get(); pat_rnw(); knit_patterns$get()
 #'
@@ -129,6 +135,8 @@ pat_rst = function() set_pattern('rst')
 pat_asciidoc = function() set_pattern('asciidoc')
 #' @rdname pat_fun
 pat_textile = function() set_pattern('textile')
+#' @rdname pat_fun
+pat_typst = function() set_pattern('typst')
 
 
 # helper functions
@@ -148,6 +156,7 @@ detect_pattern = function(text, ext) {
     if (ext %in% c('rmd', 'rmarkdown', 'markdown', 'md', 'qmd')) return('md')
     if (ext %in% c('rst', 'rrst')) return('rst')
     if (ext %in% c('asciidoc', 'rasciidoc', 'adoc', 'radoc')) return('asciidoc')
+    if (ext %in% c('rtyp')) return('typst')
   }
   for (p in names(all_patterns)) {
     for (i in c('chunk.begin', 'inline.code')) {
diff --git a/R/utils-conversion.R b/R/utils-conversion.R
@@ -52,7 +52,9 @@ knit2pandoc = function(
 #' @param compiler A character string giving the LaTeX engine used to compile
 #'   the tex document to PDF. For an Rrst file, setting \code{compiler} to
 #'   \code{'rst2pdf'} will use \code{\link{rst2pdf}} to compile the rst file to
-#'   PDF using the ReportLab open-source library.
+#'   PDF using the ReportLab open-source library. For an Rtyp file, setting
+#'   \code{compiler} to \code{'typst'} will use the \command{typst} command-line
+#'   tool to compile the typ file to PDF.
 #' @param ... Options to be passed to \code{tinytex::\link[tinytex]{latexmk}()}
 #'   or \code{\link{rst2pdf}()}.
 #' @author Ramnath Vaidyanathan, Alex Zvoleff and Yihui Xie
@@ -65,18 +67,31 @@ knit2pandoc = function(
 #'
 #' #' compile a reST file with rst2pdf
 #' ## knit2pdf(..., compiler = 'rst2pdf')
+#'
+#' #' compile an Rtyp file with typst
+#' ## knit2pdf(..., compiler = 'typst')
 knit2pdf = function(
   input, output = NULL, compiler = NULL, envir = parent.frame(), quiet = FALSE, ...
 ) {
   out = knit(input, output = output, envir = envir, quiet = quiet)
   owd = setwd(dirname(out)); on.exit(setwd(owd))
   if (is.null(compiler)) {
-    compiler = if (grepl('\\.rst$', out)) 'rst2pdf' else 'pdflatex'
+    compiler = if (grepl('\\.rst$', out)) 'rst2pdf' else
+      if (grepl('\\.typ$', out)) 'typst' else 'pdflatex'
   }
   if (identical(compiler, 'rst2pdf')) {
     if (tolower(file_ext(out)) != 'rst')
       stop('for rst2pdf compiler input must be a .rst file')
     rst2pdf(basename(out), ...)
+  } else if (identical(compiler, 'typst')) {
+    if (tolower(file_ext(out)) != 'typ')
+      stop('for typst compiler input must be a .typ file')
+    f = basename(out); o = with_ext(f, 'pdf')
+    status = system2('typst', c('compile', shQuote(f), shQuote(o)))
+    if (!file.exists(o)) stop(
+      'compilation by typst failed (exit status ', status, '); ',
+      'make sure typst is installed and available in your PATH'
+    )
   } else {
     tinytex::latexmk(basename(out), engine = compiler, ...)
   }
diff --git a/R/utils.R b/R/utils.R
@@ -212,6 +212,7 @@ format_sci_one = function(
   },
   html = sci_notation('%s%s10<sup>%s</sup>', b, ' &times; ', lx),
   md   = sci_notation('%s%s10^%s^', b, '&times; ', lx),
+  typst = sci_notation('$%s%s10^%s$', b, ' times ', lx),
   rst  = {
     # if AsIs, use the :math: directive
     if (inherits(x, 'AsIs')) {
diff --git a/man/all_patterns.Rd b/man/all_patterns.Rd
diff --git a/man/hook_plot.Rd b/man/hook_plot.Rd
diff --git a/man/knit2pdf.Rd b/man/knit2pdf.Rd
diff --git a/man/output_hooks.Rd b/man/output_hooks.Rd
diff --git a/man/pat_fun.Rd b/man/pat_fun.Rd
