quarto-preprint is a Quarto extension for rendering Quarto source documents to PDF documents via Typst. It aims to
- Just Work™️
- Typst doesn't require complicated LaTeX installations
- Be fast
- Typst creates PDF files very quickly
- Be 100% Quarto standards compliant
- Write manuscripts without worrying about formatting & metadata
- Switch to any Quarto journal format without changing anything but
format:
(and whatever is required by the destination format)
To use (see below), install the extension and set your Quarto output format to preprint-typst
. The extension also provides a preprint-docx
format, which renders Quarto source documents to MS Word documents with some basic layout improvements.
Example output: https://mvuorre.github.io/quarto-preprint/index.pdf.
Add template to an existing project:
quarto add mvuorre/quarto-preprint
Start a new Quarto project that uses quarto-preprint
:
quarto use template mvuorre/quarto-preprint
The output of Quarto documents is configured through YAML metadata either in the document's front matter (between triple dashes), or in a _quarto.yml
file. Read more about these at Quarto's guide to writing scholarly documents, Quarto's Typst format documentation, and the Typst documentation pages.
preprint-typst
aims to include all standard Quarto front matter options for scholarly writing. Please report missing features (or other bugs) on GitHub. In addition, there are a few options specific to Typst, and the quarto-preprint
format.
running-head: "*preprint* Quarto extension manual"
authornote: This is an example author note.
wordcount: "{{< words-body >}}"
running-head
should be a text string and is used as the document's running head.
authornote
allows adding information to the footer of the first page.
wordcount
add a word count using https://github.com/andrewheiss/quarto-wordcount (see above example, and link for instructions on use).
- Must add
suppress-bibliography: true
to YAML so that the wordcount extension doesn't lead to duplicated bibliographies.
Send your bug reports and pull requests to https://github.com/mvuorre/quarto-preprint. If you're reporting a bug, please include a reproducible example / full details of what you're trying to do, how, and what goes wrong.
It can be useful to also output a MS Word document for collaboration. To do so, you can include docx
as an output format as shown here. quarto-preprint
also provides a slightly improved bare-bones MS Word output format preprint-docx
.
Typst also provides an online interface. That could be especially useful for collaborating on documents. You can create a .typ file by including
format:
preprint-typst:
keep-typ: true
in the document's YAML. Then, copy-paste the resulting .typ file and other required materials (bibliography & image files, etc.) to the Typst online interface. See an example here.